version 1.24, 2009/03/26 16:23:22 |
version 1.37, 2010/02/17 19:22:01 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" 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 |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" above copyright notice and this permission notice appear in all |
.\" copyright notice and this permission notice appear in all copies. |
.\" copies. |
|
.\" |
.\" |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdoc 3 |
.Dt MDOC 3 |
.Os |
.Os |
.\" SECTION |
.\" SECTION |
.Sh NAME |
.Sh NAME |
|
|
.Nd mdoc macro compiler library |
.Nd mdoc macro compiler library |
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Fd #include <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" "const struct mdoc_cb *cb" |
.Ft void |
.Ft int |
.Fn mdoc_reset "struct mdoc *mdoc" |
.Fn mdoc_reset "struct mdoc *mdoc" |
.Ft void |
.Ft void |
.Fn mdoc_free "struct mdoc *mdoc" |
.Fn mdoc_free "struct mdoc *mdoc" |
.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_node "struct mdoc *mdoc" |
.Fn mdoc_node "const struct mdoc *mdoc" |
.Ft "const struct mdoc_meta *" |
.Ft "const struct mdoc_meta *" |
.Fn mdoc_meta "struct mdoc *mdoc" |
.Fn mdoc_meta "const struct mdoc *mdoc" |
.Ft int |
.Ft int |
.Fn mdoc_endparse "struct mdoc *mdoc" |
.Fn mdoc_endparse "struct mdoc *mdoc" |
.\" SECTION |
.\" SECTION |
.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 (and |
.Em only |
.Em only |
mdoc) into an abstract syntax tree that generalises the semantic |
mdoc) into an abstract syntax tree (AST). |
annotation of its input. Common front-ends for |
|
.Nm |
|
are |
|
.Xr mdocterm 1 , |
|
.Xr mdoclint 1 |
|
and |
|
.Xr mdoctree 1 . |
|
.\" PARAGRAPH |
.\" 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 , |
parse each line in a document with |
parse each line in a document with |
.Fn mdoc_parseln , |
.Fn mdoc_parseln , |
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_node |
.Fn mdoc_node |
and |
and |
.Fn mdoc_meta , |
.Fn mdoc_meta , |
then free all allocated memory with |
then free all allocated memory with |
Line 86 sequence. See the |
|
Line 77 sequence. See the |
|
section for a full example. |
section for a full example. |
.\" PARAGRAPH |
.\" 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 |
.\" SUBSECTION |
.Ss Types |
.Ss Types |
Line 101 Both functions (see |
|
Line 92 Both functions (see |
|
and variables (see |
and variables (see |
.Sx Variables ) |
.Sx Variables ) |
may use the following types: |
may use the following types: |
.Bl -ohang -offset "XXXX" |
.Bl -ohang |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Vt struct mdoc |
.It Vt struct mdoc |
An opaque type defined in |
An opaque type defined in |
Line 115 A set of message callbacks defined in |
|
Line 106 A set of message callbacks defined in |
|
.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. |
.El |
.El |
.\" SUBSECTION |
.\" SUBSECTION |
.Ss Functions |
.Ss Functions |
Function descriptions follow: |
Function descriptions follow: |
.Bl -ohang -offset "XXXX" |
.Bl -ohang |
.\" LIST-ITEM |
.\" 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 , |
which are documented further in the header file. |
which are documented further in the header file. |
The |
The |
.Fa pflags |
.Fa pflags |
arguments are defined in |
arguments are defined in |
Line 138 Returns NULL on failure. If non-NULL, the pointer mus |
|
Line 129 Returns NULL on failure. If non-NULL, the pointer mus |
|
.Fn mdoc_free . |
.Fn mdoc_free . |
.\" LIST-ITEM |
.\" 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. |
behaves as if invoked for the first time. If it returns 0, memory could |
|
not be allocated. |
.\" LIST-ITEM |
.\" 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 |
|
|
.\" LIST-ITEM |
.\" 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 |
.\" 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. Returns 0 on failure, 1 on success. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.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. If this information has not |
yet been supplied or |
yet been supplied or |
.Fn mdoc_parseln |
.Fn mdoc_parseln |
or |
or |
.Fn mdoc_endparse |
.Fn mdoc_endparse |
Line 176 return 0, the data will be incomplete. |
|
Line 168 return 0, the data will be incomplete. |
|
.\" SUBSECTION |
.\" SUBSECTION |
.Ss Variables |
.Ss Variables |
The following variables are also defined: |
The following variables are also defined: |
.Bl -ohang -offset "XXXX" |
.Bl -ohang |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It Va mdoc_macronames |
.It Va mdoc_macronames |
An array of string-ified token names. |
An array of string-ified token names. |
Line 186 An array of string-ified token argument names. |
|
Line 178 An array of string-ified token argument names. |
|
.El |
.El |
.\" SUBSECTION |
.\" 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 |
Line 194 regular form. It may be reviewed at any time with |
|
Line 186 regular form. It may be reviewed at any time with |
|
however, if called before |
however, if called before |
.Fn mdoc_endparse , |
.Fn mdoc_endparse , |
or after |
or after |
.Fn mdoc_endparse |
.Fn mdoc_endparse |
or |
or |
.Fn mdoc_parseln |
.Fn mdoc_parseln |
fail, it may be incomplete. |
fail, it may be incomplete. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
This AST is governed by the ontological |
This AST is governed by the ontological |
rules dictated in |
rules dictated in |
.Xr mdoc 7 |
.Xr mdoc 7 |
and derives its terminology accordingly. |
and derives its terminology accordingly. |
.Qq In-line |
.Qq In-line |
elements described in |
elements described in |
.Xr mdoc 7 |
.Xr mdoc 7 |
are described simply as |
are described simply as |
.Qq elements . |
.Qq elements . |
.\" PARAGRAPH |
.\" 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 |
|
|
fields), its position in the tree (the |
fields), its position in the tree (the |
.Va parent , |
.Va parent , |
.Va child , |
.Va child , |
.Va next |
.Va next |
and |
and |
.Va prev |
.Va prev |
fields) and type-specific data (the |
fields) and some type-specific data. |
.Va data |
|
field). |
|
.\" PARAGRAPH |
.\" 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 -offset "XXXX" |
.Bl -tag -width "ELEMENTXX" -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It ROOT |
.It ROOT |
\(<- mnode+ |
\(<- mnode+ |
Line 261 where capitalised non-terminals represent nodes. |
|
Line 251 where capitalised non-terminals represent nodes. |
|
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. These refer to punctuation marks. Furthermore, |
although a TEXT node will generally have a non-zero-length string, in |
although a TEXT node will generally have a non-zero-length string, in |
the specific case of |
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 |
.\" 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 |
.Fn parsed . |
.Fn parsed . |
Note that, if the last line of the file isn't newline-terminated, this |
This example does not error-check nor free memory upon failure. |
will truncate the file's last character (see |
.Bd -literal -offset indent |
.Xr fgetln 3 ) . |
|
Further, this example does not error-check nor free memory upon failure. |
|
.Bd -literal -offset "XXXX" |
|
struct mdoc *mdoc; |
struct mdoc *mdoc; |
struct mdoc_node *node; |
const struct mdoc_node *node; |
char *buf; |
char *buf; |
size_t len; |
size_t len; |
int line; |
int line; |
|
|
line = 1; |
line = 1; |
mdoc = mdoc_alloc(NULL, NULL); |
mdoc = mdoc_alloc(NULL, 0, NULL); |
|
buf = NULL; |
|
alloc_len = 0; |
|
|
while ((buf = fgetln(fp, &len))) { |
while ((len = getline(&buf, &alloc_len, stdin)) >= 0) { |
buf[len - 1] = '\\0'; |
if (len && buflen[len - 1] = '\en') |
if ( ! mdoc_parseln(mdoc, line, buf)) |
buf[len - 1] = '\e0'; |
errx(1, "mdoc_parseln"); |
if ( ! mdoc_parseln(mdoc, line, buf)) |
line++; |
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); |
parsed(mdoc, node); |
mdoc_free(mdoc); |
mdoc_free(mdoc); |
Line 306 mdoc_free(mdoc); |
|
Line 296 mdoc_free(mdoc); |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.\" SECTION |
.\" SECTION |
.Sh CAVEATS |
.Sh CAVEATS |
.Bl -dash -compact |
.Bl -dash -compact |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
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. |
macro. |
.\" LIST-ITEM |
.\" LIST-ITEM |
.It |
.It |
The |
The |
.Sq \&.Bsx |
.Sq \&.Bsx |
macro family doesn't yet understand version arguments. |
macro family doesn't yet understand version arguments. |
.\" LIST-ITEM |
.\" LIST-ITEM |
Line 331 If not given a value, the \-offset argument to |
|
Line 321 If not given a value, the \-offset argument to |
|
.Sq \&.Bd |
.Sq \&.Bd |
and |
and |
.Sq \&.Bl |
.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 |
.Li 10n |
is provided. |
is provided. |
.\" LIST-ITEM |
.\" LIST-ITEM |
Line 343 Columns widths in |
|
Line 333 Columns widths in |
|
should default to width |
should default to width |
.Qq <stringx> |
.Qq <stringx> |
if not included. |
if not included. |
.\" LIST-ITEM |
|
.It |
|
List-width suffix |
|
.Qq m |
|
isn't handled. |
|
.\" LIST-ITEM |
|
.It |
|
Contents of the SYNOPSIS section aren't checked. |
|
.El |
.El |