version 1.3, 2009/01/17 16:15:27 |
version 1.18, 2009/03/16 22:19:19 |
|
|
|
.\" $Id$ |
|
.\" |
|
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
|
.\" |
|
.\" 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. |
|
.\" |
|
.\" 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$ |
.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_parseln , |
.Nm mdoc_endparse , |
.Nm mdoc_endparse , |
.Nm mdoc_result , |
.Nm mdoc_node , |
|
.Nm mdoc_meta , |
.Nm mdoc_free |
.Nm mdoc_free |
.Nd mdoc macro compiler library |
.Nd mdoc macro compiler library |
.\" |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.In mdoc.h |
.Fd #include <mdoc.h> |
|
.Vt extern const char * const * mdoc_macronames; |
|
.Vt extern const char * const * mdoc_argnames; |
.Ft "struct mdoc *" |
.Ft "struct mdoc *" |
.Fn mdoc_alloc "void *data" "const struct mdoc_cb *cb" |
.Fn mdoc_alloc "void *data" "const struct mdoc_cb *cb" |
.Ft void |
.Ft void |
|
|
.Ft int |
.Ft int |
.Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf" |
.Fn mdoc_parseln "struct mdoc *mdoc" "int line" "char *buf" |
.Ft "const struct mdoc_node *" |
.Ft "const struct mdoc_node *" |
.Fn mdoc_result "struct mdoc *mdoc" |
.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" |
.Fn mdoc_endparse "struct mdoc *mdoc" |
.\" |
.\" SECTION |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm mdoc |
.Nm mdoc |
library parses lines of mdoc-macro text into an abstract syntax tree. |
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 mdoctree 1 . |
|
.\" PARAGRAPH |
|
.Pp |
In general, applications initiate a parsing sequence with |
In general, applications initiate a parsing sequence with |
.Fn mdoc_alloc , |
.Fn mdoc_alloc , |
parse each line in a document with |
parse each line in a document with |
Line 35 parse each line in a document with |
|
Line 70 parse each line in a document with |
|
close the parsing session with |
close the parsing session with |
.Fn mdoc_endparse , |
.Fn mdoc_endparse , |
operate over the syntax tree returned by |
operate over the syntax tree returned by |
.Fn mdoc_result , |
.Fn mdoc_node |
|
and |
|
.Fn mdoc_meta , |
then free all allocated memory with |
then free all allocated memory with |
.Fn mdoc_free . |
.Fn mdoc_free . |
See the |
See the |
.Sx EXAMPLES |
.Sx EXAMPLES |
section for a full example. |
section for a full example. |
|
.\" PARAGRAPH |
.Pp |
.Pp |
|
This section further defines the |
|
.Sx Types , |
|
.Sx Functions |
|
and |
|
.Sx Variables |
|
available to programmers. Following that, the |
|
.Sx Abstract Syntax Tree |
|
section documents the output tree. |
|
.\" SUBSECTION |
|
.Ss Types |
|
Both functions (see |
|
.Sx Functions ) |
|
and variables (see |
|
.Sx Variables ) |
|
may use the following types: |
|
.Bl -ohang -offset "XXXX" |
|
.\" LIST-ITEM |
|
.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 |
|
A parsed node. Defined in |
|
.Pa mdoc.h . |
|
See |
|
.Sx Abstract Syntax Tree |
|
for details. |
|
.El |
|
.\" SUBSECTION |
|
.Ss Functions |
Function descriptions follow: |
Function descriptions follow: |
.Bl -ohang -offset indent |
.Bl -ohang -offset "XXXX" |
|
.\" LIST-ITEM |
.It Fn mdoc_alloc |
.It Fn mdoc_alloc |
Allocates a parsing structure. The |
Allocates a parsing structure. The |
.Fa data |
.Fa data |
Line 52 pointer is passed to callbacks in |
|
Line 126 pointer is passed to callbacks in |
|
which are documented further in the header file. Returns NULL on |
which are documented further in the header file. Returns NULL on |
failure. If non-NULL, the pointer must be freed with |
failure. If non-NULL, the pointer must be freed with |
.Fn mdoc_free . |
.Fn mdoc_free . |
|
.\" 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. The pointer is no longer valid after |
invocation. |
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. 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 |
.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_result , |
.Fn mdoc_node , |
the resulting tree is incomplete. Returns 0 on failure, 1 on success. |
the resulting tree is incomplete. Returns 0 on failure, 1 on success. |
.It Fn mdoc_result |
.\" LIST-ITEM |
Returns the result of the parse or NULL on failure. Note that if |
.It Fn mdoc_node |
|
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 |
|
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 |
.El |
.Pp |
.\" SUBSECTION |
|
.Ss Variables |
|
The following variables are also defined: |
|
.Bl -ohang -offset "XXXX" |
|
.\" LIST-ITEM |
|
.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 |
|
.\" SUBSECTION |
|
.Ss Abstract Syntax Tree |
|
The |
.Nm |
.Nm |
is |
functions produce an abstract syntax tree (AST) describing input in a |
.Ud |
regular form. It may be reviewed at any time with |
.\" |
.Fn mdoc_nodes ; |
|
however, if called before |
|
.Fn mdoc_endparse , |
|
or after |
|
.Fn mdoc_endparse |
|
or |
|
.Fn mdoc_parseln |
|
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 |
|
by the |
|
.Va type |
|
field. Each node also provides its parse point (the |
|
.Va line , |
|
.Va sec , |
|
and |
|
.Va pos |
|
fields), its position in the tree (the |
|
.Va parent , |
|
.Va child , |
|
.Va next |
|
and |
|
.Va prev |
|
fields) and type-specific data (the |
|
.Va data |
|
field). |
|
.\" 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" |
|
.\" LIST-ITEM |
|
.It ROOT |
|
\(<- mnode+ |
|
.It mnode |
|
\(<- BLOCK | ELEMENT | TEXT |
|
.It BLOCK |
|
\(<- (HEAD [TEXT])+ [BODY [TEXT]] [TAIL [TEXT]] |
|
.It BLOCK |
|
\(<- BODY [TEXT] [TAIL [TEXT]] |
|
.It ELEMENT |
|
\(<- TEXT* |
|
.It HEAD |
|
\(<- mnode+ |
|
.It BODY |
|
\(<- mnode+ |
|
.It TAIL |
|
\(<- mnode+ |
|
.It TEXT |
|
\(<- [[:alpha:]]* |
|
.El |
|
.\" PARAGRAPH |
|
.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, in |
|
the specific case of |
|
.Sq \&.Bd \-literal , |
|
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 86 Note that, if the last line of the file isn't newline- |
|
Line 258 Note that, if the last line of the file isn't newline- |
|
will truncate the file's last character (see |
will truncate the file's last character (see |
.Xr fgetln 3 ) . |
.Xr fgetln 3 ) . |
Further, this example does not error-check nor free memory upon failure. |
Further, this example does not error-check nor free memory upon failure. |
.Bd -literal |
.Bd -literal -offset "XXXX" |
struct mdoc *mdoc; |
struct mdoc *mdoc; |
struct mdoc_node *node; |
struct mdoc_node *node; |
char *buf; |
char *buf; |
Line 105 while ((buf = fgetln(fp, &len))) { |
|
Line 277 while ((buf = fgetln(fp, &len))) { |
|
|
|
if ( ! mdoc_endparse(mdoc)) |
if ( ! mdoc_endparse(mdoc)) |
errx(1, "mdoc_endparse"); |
errx(1, "mdoc_endparse"); |
if (NULL == (node = mdoc_result(mdoc))) |
if (NULL == (node = mdoc_node(mdoc))) |
errx(1, "mdoc_result"); |
errx(1, "mdoc_node"); |
|
|
parsed(mdoc, node); |
parsed(mdoc, node); |
mdoc_free(mdoc); |
mdoc_free(mdoc); |
.Ed |
.Ed |
.\" |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoc 7 , |
.Xr mdocterm 1 , |
.Xr mdoc.samples 7 , |
.Xr mdoclint 1 , |
.Xr groff 1 , |
.Xr mdoctree 1 , |
.Xr mdocml 1 |
.Xr mdoc 7 |
.\" |
.\" SECTION |
.\" |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" |
.\" SECTION |
.\" |
.Sh CAVEATS |
.Sh BUGS |
.Bl -dash -compact |
Both bugs and incompabilities are documented in this section. An |
.\" LIST-ITEM |
incompatible macro or behaviour is relative to the default |
.It |
.Xr groff 1 |
|
system bundled with |
|
.Ox . |
|
.Pp |
|
The |
The |
.Sq \&Xc |
.Sq \&Xc |
and |
and |
.Sq \&Xo |
.Sq \&Xo |
macros aren't handled when used to span lines for the |
macros aren't handled when used to span lines for the |
.Sq \&It |
.Sq \&It |
macro. Such usage is specifically discouraged in |
macro. |
.Xr mdoc.samples 7 . |
.\" LIST-ITEM |
.Pp |
.It |
When |
|
.Sq \&It \-column |
|
is invoked, whitespace is not stripped around |
|
.Sq \&Ta |
|
or tab-character separators. |
|
.Pp |
|
The |
The |
.Sq \&At |
.Sq \&Bsx |
macro only accepts a single parameter. |
macro doesn't yet understand version arguments. |
|
.El |