=================================================================== RCS file: /cvs/mandoc/Attic/mdoc.3,v retrieving revision 1.14 retrieving revision 1.20 diff -u -p -r1.14 -r1.20 --- mandoc/Attic/mdoc.3 2009/03/12 15:55:11 1.14 +++ mandoc/Attic/mdoc.3 2009/03/20 15:14:01 1.20 @@ -1,6 +1,6 @@ -.\" $Id: mdoc.3,v 1.14 2009/03/12 15:55:11 kristaps Exp $ +.\" $Id: mdoc.3,v 1.20 2009/03/20 15:14:01 kristaps Exp $ .\" -.\" Copyright (c) 2009 Kristaps Dzonsons +.\" Copyright (c) 2009 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the @@ -16,7 +16,7 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 12 2009 $ +.Dd $Mdocdate: March 20 2009 $ .Dt mdoc 3 .Os .\" SECTION @@ -26,7 +26,8 @@ .Nm mdoc_endparse , .Nm mdoc_node , .Nm mdoc_meta , -.Nm mdoc_free +.Nm mdoc_free , +.Nm mdoc_reset .Nd mdoc macro compiler library .\" SECTION .Sh SYNOPSIS @@ -34,8 +35,10 @@ .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" "const struct mdoc_cb *cb" .Ft void +.Fn mdoc_reset "struct mdoc *mdoc" +.Ft void .Fn mdoc_free "struct mdoc *mdoc" .Ft int .Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf" @@ -49,27 +52,20 @@ .Sh DESCRIPTION The .Nm mdoc -library parses lines of mdoc input into an abstract syntax tree. -.Dq mdoc , -which is used to format BSD manual pages, is a macro package of the -.Dq roff -language. The -.Nm -library implements only those macros documented in the +library parses lines of .Xr mdoc 7 +input (and +.Em only +mdoc) into an abstract syntax tree that generalises the semantic +annotation of its input. Common front-ends for +.Nm +are +.Xr mdocterm 1 , +.Xr mdoclint 1 and -.Xr mdoc.samples 7 -manuals. Documents with -.Xr refer 1 , -.Xr eqn 1 -and other pre-processor sections aren't accomodated. +.Xr mdoctree 1 . .\" PARAGRAPH .Pp -.Nm -is -.Ud -.\" PARAGRAPH -.Pp In general, applications initiate a parsing sequence with .Fn mdoc_alloc , parse each line in a document with @@ -82,7 +78,10 @@ and .Fn mdoc_meta , then free all allocated memory with .Fn mdoc_free . -See the +The +.Fn mdoc_reset +function may be used in order to reset the parser for another input +sequence. See the .Sx EXAMPLES section for a full example. .\" PARAGRAPH @@ -92,11 +91,9 @@ This section further defines the .Sx Functions and .Sx Variables -available to programmers. Following that, -.Sx Character Encoding -describes input format. Lastly, -.Sx Abstract Syntax Tree , -documents the output tree. +available to programmers. Following that, the +.Sx Abstract Syntax Tree +section documents the output tree. .\" SUBSECTION .Ss Types Both functions (see @@ -132,10 +129,19 @@ Allocates a parsing structure. The .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 +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 . .\" 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. +.\" LIST-ITEM .It Fn mdoc_free Free all resources of a parser. The pointer is no longer valid after invocation. @@ -179,68 +185,11 @@ An array of string-ified token names. An array of string-ified token argument names. .El .\" SUBSECTION -.Ss Character Encoding -The -.Xr mdoc 3 -library accepts only printable ASCII characters as defined by -.Xr isprint 3 . -Non-ASCII character sequences are delimited in various ways. All are -preceeded by an escape character -.Sq \\ -and followed by either an open-parenthesis -.Sq \&( -for two-character sequences; an open-bracket -.Sq \&[ -for n-character sequences (terminated at a close-bracket -.Sq \&] ) ; -an asterisk and open-parenthesis -.Sq \&*( -for two-character sequences; -an asterisk and non-open-parenthesis -.Sq \&* -for single-character sequences; or one of a small set of standalone -single characters for other escapes. -.\" PARAGRAPH -.Pp -Examples: -.Pp -.Bl -tag -width "XXXXXXXX" -offset "XXXX" -compact -.\" LIST-ITEM -.It \\*(<= -prints -.Dq \*(<= -.Pq greater-equal -.\" LIST-ITEM -.It \\(<- -prints -.Dq \(<- -.Pq left-arrow -.\" LIST-ITEM -.It \\[<-] -also prints -.Dq \(<- -.Pq left-arrow -.\" LIST-ITEM -.It \\*(Ba -prints -.Dq \*(Ba -.Pq bar -.\" LIST-ITEM -.It \\*q -prints -.Dq \*q -.Pq double-quote -.El -.\" PARAGRAPH -.Pp -All escaped sequences are syntax-checked, but it's up to the front-end -system to correctly render them to the output device. -.\" SUBSECTION .Ss Abstract Syntax Tree The .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 , @@ -248,9 +197,20 @@ or after .Fn mdoc_endparse 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 +and derives its terminology accordingly. +.Qq In-line +elements described in +.Xr mdoc 7 +are described simply as +.Qq elements . +.\" PARAGRAPH +.Pp The AST is composed of .Vt struct mdoc_node nodes with block, head, body, element, root and text types as declared @@ -304,27 +264,6 @@ although a TEXT node will generally have a non-zero-le the specific case of .Sq \&.Bd \-literal , 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 -.Sq \&.Em foo , -are classified as ELEMENT nodes, which can only contain text. -Multi-line elements, such as -.Sq \&.Sh , -are BLOCK elements, where the HEAD constitutes line contents and the -BODY constitutes subsequent lines. In-line elements with matching -pairs, such as -.Sq \&.So -and -.Sq \&.Sc , -are BLOCK elements with no HEAD tag. The only exception to this is -.Sq \&.Eo -and -.Sq \&.Ec , -which has a HEAD and TAIL node corresponding to the enclosure string. -TEXT nodes, obviously, constitute text, and the ROOT node is the -document's root. .\" SECTION .Sh EXAMPLES The following example reads lines from stdin and parses them, operating @@ -360,53 +299,18 @@ parsed(mdoc, node); mdoc_free(mdoc); .Ed .\" SECTION -.Sh COMPATIBILITY -In general, only those macros specified by -.Xr mdoc.samples 7 -and +.Sh SEE ALSO +.Xr mandoc 1 , .Xr mdoc 7 -for -.Ox -and -.Nx -are supported; support for other -.Bx -systems is in progress. -.Bl -bullet -.\" LIST-ITEM -.It -NetBSD -.Sq \&It \-nested -is assumed for all lists: any list may be nested and -.Sq \-enum -lists will restart the sequence only for the sub-list. -.\" LIST-ITEM -.It -Newer NetBSD-style -.Sq \&It \-column -syntax, where column widths may be preceeded by other arguments (instead -of proceeded), is not supported. -.\" LIST-ITEM -.It -The -.Sq \&At -macro only accepts a single parameter. -.El .\" SECTION -.Sh SEE ALSO -.Xr mdoc 7 , -.Xr mdoc.samples 7 , -.Xr groff 1 , -.Xr mdocml 1 -.\" SECTION .Sh AUTHORS The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@openbsd.org . .\" SECTION .Sh CAVEATS -.Bl -bullet +.Bl -dash -compact .\" LIST-ITEM .It The @@ -415,6 +319,10 @@ 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 . +macro. +.\" LIST-ITEM +.It +The +.Sq \&Bsx +macro doesn't yet understand version arguments. .El