Clean-up: added `Nm mdoc' to mdoc.3.

[mandoc.git] / mdoc.3

diff --git a/mdoc.3 b/mdoc.3
index 76f33555ddd2b9fd6d6b07f0c230c31ecef50ac3..32df3378102236bfa61a45d8d7f4f9ceb69e4944 100644 (file)
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,98 +1,88 @@
-.\" $Id: mdoc.3,v 1.6 2009/02/23 09:33:34 kristaps Exp $
+.\"    $Id: mdoc.3,v 1.39 2010/05/25 21:46:48 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
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any

-.\" purpose with or without fee is hereby granted, provided that the
-.\" above copyright notice and this permission notice appear in all
-.\" copies.
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.

 .\"
 .\"

-.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-.\" DAMAGES OR ANY DAMAGES 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: February 23 2009 $
-.Dt mdoc 3
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" 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: May 25 2010 $
+.Dt MDOC 3

 .Os
 .Os

-.\" SECTION

 .Sh NAME
 .Sh NAME

+.Nm mdoc ,

 .Nm mdoc_alloc ,
 .Nm mdoc_alloc ,

-.Nm mdoc_parseln ,

 .Nm mdoc_endparse ,
 .Nm mdoc_endparse ,

-.Nm mdoc_node ,
+.Nm mdoc_free ,

 .Nm mdoc_meta ,
 .Nm mdoc_meta ,

-.Nm mdoc_free
+.Nm mdoc_node ,
+.Nm mdoc_parseln ,
+.Nm mdoc_reset

 .Nd mdoc macro compiler library
 .Nd mdoc macro compiler library

-.\" SECTION

 .Sh SYNOPSIS
 .Sh SYNOPSIS

-.Fd #include <mdoc.h>
+.In mandoc.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 *"

-.Fn mdoc_alloc "void *data" "const struct mdoc_cb *cb"
+.Fn mdoc_alloc "void *data" "int pflags" "mandocmsg msgs"
+.Ft int
+.Fn mdoc_endparse "struct mdoc *mdoc"

 .Ft void
 .Fn mdoc_free "struct mdoc *mdoc"
 .Ft void
 .Fn mdoc_free "struct mdoc *mdoc"

+.Ft "const struct mdoc_meta *"
+.Fn mdoc_meta "const struct mdoc *mdoc"
+.Ft "const struct mdoc_node *"
+.Fn mdoc_node "const struct mdoc *mdoc"

 .Ft int
 .Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf"
 .Ft int
 .Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf"

-.Ft "const struct mdoc_node *"
-.Fn mdoc_node "struct mdoc *mdoc"
-.Ft "const struct mdoc_meta *"
-.Fn mdoc_meta "struct mdoc *mdoc"

 .Ft int
 .Ft int

-.Fn mdoc_endparse "struct mdoc *mdoc"
-.\" SECTION
+.Fn mdoc_reset "struct mdoc *mdoc"

 .Sh DESCRIPTION
 The
 .Nm mdoc
 .Sh DESCRIPTION
 The
 .Nm mdoc

-library parses lines of mdoc input into an abstract syntax tree.  
-.Dq mdoc
-is a macro package of the
-.Dq roff
-language, which is used to format BSD manual pages.  The 
-.Nm
-library implements only those macros documented in the
+library parses lines of

 .Xr mdoc 7
 .Xr mdoc 7

-and
-.Xr mdoc.samples 7
-manuals.
-.\" PARAGRAPH
-.Pp
-.Nm
-is
-.Ud
-.\" PARAGRAPH
+input
+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
 .Fn mdoc_free .
 and
 .Fn mdoc_meta ,
 then free all allocated memory with
 .Fn mdoc_free .

+The
+.Fn mdoc_reset
+function may be used in order to reset the parser for another input
+sequence.

 See the
 .Sx EXAMPLES
 See the
 .Sx EXAMPLES

-section for a full example.
-.\" PARAGRAPH
+section for a simple example.

 .Pp
 .Pp

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

 .Sx Types ,
 .Sx Types ,

-.Sx Functions 
+.Sx Functions

 and
 .Sx Variables
 and
 .Sx Variables

-available to programmers.  The last sub-section,
-.Sx Abstract Syntax Tree ,
-documents the output tree.
-.\" SUBSECTION
+available to programmers.
+Following that, the
+.Sx Abstract Syntax Tree
+section documents the output tree.

 .Ss Types
 Both functions (see
 .Sx Functions )
 .Ss Types
 Both functions (see
 .Sx Functions )


@@ -100,101 +90,117 @@ and variables (see
 .Sx Variables )
 may use the following types:
 .Bl -ohang
 .Sx Variables )
 may use the following types:
 .Bl -ohang

-.\" LIST-ITEM

 .It Vt struct mdoc
 An opaque type defined in
 .Pa mdoc.c .
 Its values are only used privately within the library.
 .It Vt struct mdoc
 An opaque type defined in
 .Pa mdoc.c .
 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
 for details.
 .Sx Abstract Syntax Tree
 for details.

+.It Vt mandocmsg
+A function callback type defined in
+.Pa mandoc.h .

 .El
 .El

-.\" SUBSECTION

 .Ss Functions
 Function descriptions follow:
 .Ss Functions
 Function descriptions follow:

-.Bl -ohang 
-.\" LIST-ITEM
+.Bl -ohang

 .It Fn mdoc_alloc
 .It Fn mdoc_alloc

-Allocates a parsing structure.  The
+Allocates a parsing structure.
+The

 .Fa data
 pointer is passed to callbacks in
 .Fa data
 pointer is passed to callbacks in

-.Fa cb , 
-which are documented further in the header file.  Returns NULL on
-failure.  If non-NULL, the pointer must be freed with
+.Fa cb ,
+which are documented further in the header file.
+The
+.Fa pflags
+arguments are defined in
+.Pa mdoc.h .
+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
+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.

 .It Fn mdoc_free
 .It Fn mdoc_free

-Free all resources of a parser.  The pointer is no longer valid after
-invocation.
-.\" LIST-ITEM
+Free all resources of a parser.
+The pointer is no longer valid after invocation.

 .It Fn mdoc_parseln
 .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 
+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

 .Fa buf
 is modified by this function.
 .Fa buf
 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
 is called subsequent to
 .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
+the resulting tree is incomplete.
+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
 or
 .Fn mdoc_endparse
 return 0, the tree will be incomplete.
 .It Fn mdoc_meta
 .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 
+Returns the document's parsed meta-data.
+If this information has not yet been supplied or

 .Fn mdoc_parseln
 or
 .Fn mdoc_endparse
 return 0, the data will be incomplete.
 .El
 .Fn mdoc_parseln
 or
 .Fn mdoc_endparse
 return 0, the data will be incomplete.
 .El

-.\" SUBSECTION

 .Ss Variables
 The following variables are also defined:
 .Bl -ohang
 .Ss Variables
 The following variables are also defined:
 .Bl -ohang

-.\" LIST-ITEM

 .It Va mdoc_macronames
 An array of string-ified token names.
 .It Va mdoc_macronames
 An array of string-ified token names.

-.\" LIST-ITEM

 .It Va mdoc_argnames
 An array of string-ified token argument names.
 .El
 .It Va mdoc_argnames
 An array of string-ified token argument names.
 .El

-.\" SUBSECTION

 .Ss Abstract Syntax Tree
 .Ss Abstract Syntax Tree

-The 
+The

 .Nm
 .Nm

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

 .Fn mdoc_nodes ;
 however, if called before
 .Fn mdoc_endparse ,
 or after
 .Fn mdoc_nodes ;
 however, if called before
 .Fn mdoc_endparse ,
 or after

-.Fn mdoc_endparse 
+.Fn mdoc_endparse

 or
 .Fn mdoc_parseln
 fail, it may be incomplete.
 or
 .Fn mdoc_parseln
 fail, it may be incomplete.

-.\" PARAGRAPH

 .Pp
 .Pp

-The AST is composed of 
+This AST is governed by the ontological
+rules dictated in
+.Xr mdoc 7
+and derives its terminology accordingly.
+.Qq In-line
+elements described in
+.Xr mdoc 7
+are described simply as
+.Qq elements .
+.Pp
+The AST is composed of

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

-field.  Each node also provides its parse point (the
+field.
+Each node also provides its parse point (the

 .Va line ,
 .Va sec ,
 and
 .Va line ,
 .Va sec ,
 and


@@ -202,19 +208,15 @@ 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 
-fields) and type-specific data (the
-.Va data
-field).
-.\" PARAGRAPH
+.Va prev
+fields) and some type-specific data.

 .Pp
 The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.
 .Pp
 .Bl -tag -width "ELEMENTXX" -compact
 .Pp
 The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.
 .Pp
 .Bl -tag -width "ELEMENTXX" -compact

-.\" LIST-ITEM

 .It ROOT
 \(<- mnode+
 .It mnode
 .It ROOT
 \(<- mnode+
 .It mnode


@@ -232,123 +234,58 @@ where capitalised non-terminals represent nodes.
 .It TAIL
 \(<- mnode+
 .It TEXT
 .It TAIL
 \(<- mnode+
 .It TEXT

-\(<- [[:alpha:]]*
+\(<- [[:printable:],0x1e]*

 .El
 .El

-.\" PARAGRAPH

 .Pp
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
 .Pp
 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, it
-certain cases, such as 
-.Dq \&.Bd \-literal ,
+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
+.Sq \&.Bd \-literal ,

 an empty line will produce a zero-length string.
 an empty line will produce a zero-length string.

-.\" PARAGRAPH
-.Pp
-The rule-of-thumb for mapping node types to macros follows: in-line
-elements, such as 
-.Dq \&.Em foo ,
-are classified as ELEMENT nodes, which can only contain text.
-Multi-line elements such as
-.Dq \&.Sh
-are BLOCK elements, where the HEAD constitutes line contents and the
-BODY constitutes subsequent lines.  In-line elements with matching
-pairs, such as
-.Dq \&.So
-and
-.Dq \&.Sc ,
-are BLOCK elements with no HEAD tag.  The only exception to this is
-.Dq \&.Eo 
-and
-.Dq \&.Ec ,
-which has a HEAD and TAIL node corresponding to the enclosure string.
-TEXT nodes, obviously, constitute text; the ROOT node is the document's
-root.
-.\" SECTION

 .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating
 .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
+This example does not error-check nor free memory upon failure.
+.Bd -literal -offset indent

 struct mdoc *mdoc;
 struct mdoc *mdoc;

-struct mdoc_node *node;
+const struct mdoc_node *node;

 char *buf;
 size_t len;
 int line;
 
 line = 1;
 char *buf;
 size_t len;
 int line;
 
 line = 1;

-mdoc = mdoc_alloc(NULL, NULL);
+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);
 .Ed
 
 parsed(mdoc, node);
 mdoc_free(mdoc);
 .Ed

-.\" SECTION
+.Pp
+Please see
+.Pa main.c
+in the source archive for a rigorous reference.

 .Sh SEE ALSO
 .Sh SEE ALSO

-.Xr mdoc 7 ,
-.Xr mdoc.samples 7 ,
-.Xr groff 1 ,
-.Xr mdocml 1
-.\" SECTION
+.Xr mandoc 1 ,
+.Xr mdoc 7

 .Sh AUTHORS
 The
 .Nm
 .Sh AUTHORS
 The
 .Nm

-utility was written by 
-.An Kristaps Dzonsons Aq kristaps@kth.se .
-.\" SECTION
-.Sh BUGS
-Bugs, un-implemented macros and incompabilities are documented in this
-section.  The baseline for determining whether macro parsing is 
-.Qq incompatible
-is the default
-.Xr groff 1
-system bundled with 
-.Ox .
-.Pp
-Un-implemented: the 
-.Sq \&Xc
-and
-.Sq \&Xo
-macros aren't handled when used to span lines for the
-.Sq \&It
-macro.  Such usage is specifically discouraged in
-.Xr mdoc.samples 7 .
-.Pp
-Bugs: when 
-.Sq \&It \-column
-is invoked, whitespace is not stripped around
-.Sq \&Ta
-or tab-character separators.
-.Pp
-Incompatible: the 
-.Sq \&At
-macro only accepts a single parameter.  Furthermore, several macros 
-.Pf ( Sq \&Pp ,
-.Sq \&It ,
-and possibly others) accept multiple arguments with a warning.
-.Pp
-Incompatible: only those macros specified by
-.Xr mdoc.samples 7
-and
-.Xr mdoc 7
-for
-.Ox
-are supported; support for
-.Nx
-and other 
-.Bx
-systems is in progress.
+library was written by
+.An Kristaps Dzonsons Aq kristaps@bsd.lv .