no more info on bugs FIXED in bsd.lv;

[mandoc.git] / mdoc.3

diff --git a/mdoc.3 b/mdoc.3
index 4aac6f311437e7a5b1bd434dfa7c5290b81d80c3..22087afb3b2a83f11be72595b943a15acc591293 100644 (file)
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,6 +1,6 @@
-.\"    $Id: mdoc.3,v 1.32 2009/07/19 08:34:59 kristaps Exp $
+.\"    $Id: mdoc.3,v 1.37 2010/02/17 19:22:01 kristaps Exp $

 .\"
 .\"

-.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+.\" Copyright (c) 2009-2010 Kristaps Dzonsons <kristaps@bsd.lv>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -13,8 +13,8 @@
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

-.\" 
-.Dd $Mdocdate: July 19 2009 $
+.\"
+.Dd $Mdocdate: February 17 2010 $

 .Dt MDOC 3
 .Os
 .\" SECTION
 .Dt MDOC 3
 .Os
 .\" SECTION


@@ -29,7 +29,7 @@
 .Nd mdoc macro compiler library
 .\" SECTION
 .Sh SYNOPSIS
 .Nd mdoc macro compiler library
 .\" SECTION
 .Sh SYNOPSIS

-.Fd #include <mdoc.h>
+.In mdoc.h

 .Vt extern const char * const * mdoc_macronames;
 .Vt extern const char * const * mdoc_argnames;
 .Ft "struct mdoc *"
 .Vt extern const char * const * mdoc_macronames;
 .Vt extern const char * const * mdoc_argnames;
 .Ft "struct mdoc *"


@@ -50,7 +50,7 @@
 .Sh DESCRIPTION
 The
 .Nm mdoc
 .Sh DESCRIPTION
 The
 .Nm mdoc

-library parses lines of 
+library parses lines of

 .Xr mdoc 7
 input (and
 .Em only
 .Xr mdoc 7
 input (and
 .Em only


@@ -59,12 +59,12 @@ mdoc) into an abstract syntax tree (AST).
 .Pp
 In general, applications initiate a parsing sequence with
 .Fn mdoc_alloc ,
 .Pp
 In general, applications initiate a parsing sequence with
 .Fn mdoc_alloc ,

-parse each line in a document with 
+parse each line in a document with

 .Fn mdoc_parseln ,
 close the parsing session with
 .Fn mdoc_endparse ,
 operate over the syntax tree returned by
 .Fn mdoc_parseln ,
 close the parsing session with
 .Fn mdoc_endparse ,
 operate over the syntax tree returned by

-.Fn mdoc_node 
+.Fn mdoc_node

 and
 .Fn mdoc_meta ,
 then free all allocated memory with
 and
 .Fn mdoc_meta ,
 then free all allocated memory with


@@ -77,13 +77,13 @@ sequence.  See the
 section for a full example.
 .\" PARAGRAPH
 .Pp
 section for a full example.
 .\" PARAGRAPH
 .Pp

-This section further defines the 
+This section further defines the

 .Sx Types ,
 .Sx Types ,

-.Sx Functions 
+.Sx Functions

 and
 .Sx Variables
 available to programmers.  Following that, the
 and
 .Sx Variables
 available to programmers.  Following that, the

-.Sx Abstract Syntax Tree 
+.Sx Abstract Syntax Tree

 section documents the output tree.
 .\" SUBSECTION
 .Ss Types
 section documents the output tree.
 .\" SUBSECTION
 .Ss Types


@@ -92,7 +92,7 @@ Both functions (see
 and variables (see
 .Sx Variables )
 may use the following types:
 and variables (see
 .Sx Variables )
 may use the following types:

-.Bl -ohang -offset "XXXX"
+.Bl -ohang

 .\" LIST-ITEM
 .It Vt struct mdoc
 An opaque type defined in
 .\" LIST-ITEM
 .It Vt struct mdoc
 An opaque type defined in


@@ -106,21 +106,21 @@ A set of message callbacks defined in
 .It Vt struct mdoc_node
 A parsed node.  Defined in
 .Pa mdoc.h .
 .It Vt struct mdoc_node
 A parsed node.  Defined in
 .Pa mdoc.h .

-See 
+See

 .Sx Abstract Syntax Tree
 for details.
 .El
 .\" SUBSECTION
 .Ss Functions
 Function descriptions follow:
 .Sx Abstract Syntax Tree
 for details.
 .El
 .\" SUBSECTION
 .Ss Functions
 Function descriptions follow:

-.Bl -ohang -offset "XXXX"
+.Bl -ohang

 .\" LIST-ITEM
 .It Fn mdoc_alloc
 Allocates a parsing structure.  The
 .Fa data
 pointer is passed to callbacks in
 .\" LIST-ITEM
 .It Fn mdoc_alloc
 Allocates a parsing structure.  The
 .Fa data
 pointer is passed to callbacks in

-.Fa cb , 
-which are documented further in the header file.  
+.Fa cb ,
+which are documented further in the header file.

 The
 .Fa pflags
 arguments are defined in
 The
 .Fa pflags
 arguments are defined in


@@ -129,7 +129,7 @@ Returns NULL on failure.  If non-NULL, the pointer must be freed with
 .Fn mdoc_free .
 .\" LIST-ITEM
 .It Fn mdoc_reset
 .Fn mdoc_free .
 .\" LIST-ITEM
 .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
 behaves as if invoked for the first time.  If it returns 0, memory could
 not be allocated.
 .Fn mdoc_parseln
 behaves as if invoked for the first time.  If it returns 0, memory could
 not be allocated.


@@ -140,26 +140,26 @@ invocation.
 .\" LIST-ITEM
 .It Fn mdoc_parseln
 Parse a nil-terminated line of input.  This line should not contain the
 .\" LIST-ITEM
 .It Fn mdoc_parseln
 Parse a nil-terminated line of input.  This line should not contain the

-trailing newline.  Returns 0 on failure, 1 on success.  The input buffer 
+trailing newline.  Returns 0 on failure, 1 on success.  The input buffer

 .Fa buf
 is modified by this function.
 .\" LIST-ITEM
 .It Fn mdoc_endparse
 .Fa buf
 is modified by this function.
 .\" LIST-ITEM
 .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
 is called subsequent to
 .Fn mdoc_node ,
 the resulting tree is incomplete.  Returns 0 on failure, 1 on success.
 .\" LIST-ITEM
 .It Fn mdoc_node
 .Fn mdoc_endparse
 is called subsequent to
 .Fn mdoc_node ,
 the resulting tree is incomplete.  Returns 0 on failure, 1 on success.
 .\" LIST-ITEM
 .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
 or
 .Fn mdoc_endparse
 return 0, the tree will be incomplete.
 .It Fn mdoc_meta
 Returns the document's parsed meta-data.  If this information has not
 .Fn mdoc_parseln
 or
 .Fn mdoc_endparse
 return 0, the tree will be incomplete.
 .It Fn mdoc_meta
 Returns the document's parsed meta-data.  If this information has not

-yet been supplied or 
+yet been supplied or

 .Fn mdoc_parseln
 or
 .Fn mdoc_endparse
 .Fn mdoc_parseln
 or
 .Fn mdoc_endparse


@@ -168,7 +168,7 @@ return 0, the data will be incomplete.
 .\" SUBSECTION
 .Ss Variables
 The following variables are also defined:
 .\" SUBSECTION
 .Ss Variables
 The following variables are also defined:

-.Bl -ohang -offset "XXXX"
+.Bl -ohang

 .\" LIST-ITEM
 .It Va mdoc_macronames
 An array of string-ified token names.
 .\" LIST-ITEM
 .It Va mdoc_macronames
 An array of string-ified token names.


@@ -178,7 +178,7 @@ An array of string-ified token argument names.
 .El
 .\" SUBSECTION
 .Ss Abstract Syntax Tree
 .El
 .\" SUBSECTION
 .Ss Abstract Syntax Tree

-The 
+The

 .Nm
 functions produce an abstract syntax tree (AST) describing input in a
 regular form.  It may be reviewed at any time with
 .Nm
 functions produce an abstract syntax tree (AST) describing input in a
 regular form.  It may be reviewed at any time with


@@ -186,24 +186,24 @@ regular form.  It may be reviewed at any time with
 however, if called before
 .Fn mdoc_endparse ,
 or after
 however, if called before
 .Fn mdoc_endparse ,
 or after

-.Fn mdoc_endparse 
+.Fn mdoc_endparse

 or
 .Fn mdoc_parseln
 or
 .Fn mdoc_parseln

-fail, it may be incomplete.  
+fail, it may be incomplete.

 .\" PARAGRAPH
 .Pp
 This AST is governed by the ontological
 rules dictated in
 .Xr mdoc 7
 .\" PARAGRAPH
 .Pp
 This AST is governed by the ontological
 rules dictated in
 .Xr mdoc 7

-and derives its terminology accordingly.  
+and derives its terminology accordingly.

 .Qq In-line
 elements described in
 .Xr mdoc 7
 .Qq In-line
 elements described in
 .Xr mdoc 7

-are described simply as 
+are described simply as

 .Qq elements .
 .\" PARAGRAPH
 .Pp
 .Qq elements .
 .\" PARAGRAPH
 .Pp

-The AST is composed of 
+The AST is composed of

 .Vt struct mdoc_node
 nodes with block, head, body, element, root and text types as declared
 by the
 .Vt struct mdoc_node
 nodes with block, head, body, element, root and text types as declared
 by the


@@ -216,16 +216,16 @@ and
 fields), its position in the tree (the
 .Va parent ,
 .Va child ,
 fields), its position in the tree (the
 .Va parent ,
 .Va child ,

-.Va next 
+.Va next

 and
 and

-.Va prev 
+.Va prev

 fields) and some type-specific data.
 .\" PARAGRAPH
 .Pp
 The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.
 .Pp
 fields) and some type-specific data.
 .\" PARAGRAPH
 .Pp
 The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.
 .Pp

-.Bl -tag -width "ELEMENTXX" -compact -offset "XXXX"
+.Bl -tag -width "ELEMENTXX" -compact

 .\" LIST-ITEM
 .It ROOT
 \(<- mnode+
 .\" LIST-ITEM
 .It ROOT
 \(<- mnode+


@@ -251,19 +251,16 @@ where capitalised non-terminals represent nodes.
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
 the BLOCK production.  These refer to punctuation marks.  Furthermore,
 although a TEXT node will generally have a non-zero-length string, in
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
 the BLOCK production.  These refer to punctuation marks.  Furthermore,
 although a TEXT node will generally have a non-zero-length string, in

-the specific case of 
+the specific case of

 .Sq \&.Bd \-literal ,
 an empty line will produce a zero-length string.
 .\" SECTION
 .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating
 .Sq \&.Bd \-literal ,
 an empty line will produce a zero-length string.
 .\" SECTION
 .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating

-on the finished parse tree with 
+on the finished parse tree with

 .Fn parsed .
 .Fn parsed .

-Note that, if the last line of the file isn't newline-terminated, this
-will truncate the file's last character (see 
-.Xr fgetln 3 ) .
-Further, this example does not error-check nor free memory upon failure.
-.Bd -literal -offset "XXXX"
+This example does not error-check nor free memory upon failure.
+.Bd -literal -offset indent

 struct mdoc *mdoc;
 const struct mdoc_node *node;
 char *buf;
 struct mdoc *mdoc;
 const struct mdoc_node *node;
 char *buf;


@@ -272,18 +269,21 @@ int line;
 
 line = 1;
 mdoc = mdoc_alloc(NULL, 0, NULL);
 
 line = 1;
 mdoc = mdoc_alloc(NULL, 0, NULL);

+buf = NULL;
+alloc_len = 0;

 
 

-while ((buf = fgetln(fp, &len))) {
-       buf[len - 1] = '\\0';
-       if ( ! mdoc_parseln(mdoc, line, buf))
-               errx(1, "mdoc_parseln");
-       line++;
+while ((len = getline(&buf, &alloc_len, stdin)) >= 0) {
+    if (len && buflen[len - 1] = '\en')
+        buf[len - 1] = '\e0';
+    if ( ! mdoc_parseln(mdoc, line, buf))
+        errx(1, "mdoc_parseln");
+    line++;

 }
 
 if ( ! mdoc_endparse(mdoc))
 }
 
 if ( ! mdoc_endparse(mdoc))

-       errx(1, "mdoc_endparse");
+    errx(1, "mdoc_endparse");

 if (NULL == (node = mdoc_node(mdoc)))
 if (NULL == (node = mdoc_node(mdoc)))

-       errx(1, "mdoc_node");
+    errx(1, "mdoc_node");

 
 parsed(mdoc, node);
 mdoc_free(mdoc);
 
 parsed(mdoc, node);
 mdoc_free(mdoc);


@@ -296,23 +296,23 @@ mdoc_free(mdoc);
 .Sh AUTHORS
 The
 .Nm
 .Sh AUTHORS
 The
 .Nm

-utility was written by 
-.An Kristaps Dzonsons Aq kristaps@kth.se .
+utility was written by
+.An Kristaps Dzonsons Aq kristaps@bsd.lv .

 .\" SECTION
 .Sh CAVEATS
 .Bl -dash -compact
 .\" LIST-ITEM
 .It
 .\" SECTION
 .Sh CAVEATS
 .Bl -dash -compact
 .\" LIST-ITEM
 .It

-The 
+The

 .Sq \&.Xc
 and
 .Sq \&.Xo
 macros aren't handled when used to span lines for the
 .Sq \&.It
 .Sq \&.Xc
 and
 .Sq \&.Xo
 macros aren't handled when used to span lines for the
 .Sq \&.It

-macro. 
+macro.

 .\" LIST-ITEM
 .It
 .\" LIST-ITEM
 .It

-The 
+The

 .Sq \&.Bsx
 macro family doesn't yet understand version arguments.
 .\" LIST-ITEM
 .Sq \&.Bsx
 macro family doesn't yet understand version arguments.
 .\" LIST-ITEM


@@ -321,9 +321,9 @@ If not given a value, the \-offset argument to
 .Sq \&.Bd
 and
 .Sq \&.Bl
 .Sq \&.Bd
 and
 .Sq \&.Bl

-should be the width of 
+should be the width of

 .Qq <string> ;
 .Qq <string> ;

-instead, a value of 
+instead, a value of

 .Li 10n
 is provided.
 .\" LIST-ITEM
 .Li 10n
 is provided.
 .\" LIST-ITEM