version 1.14, 2011/10/06 22:29:12 |
version 1.42, 2018/08/23 19:33:27 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" 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 |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm mandoc , |
.Nm mandoc , |
.Nm mandoc_escape , |
.Nm deroff , |
.Nm man_meta , |
.Nm mandocmsg , |
.Nm man_mparse , |
.Nm man_validate , |
.Nm man_node , |
.Nm mdoc_validate , |
.Nm mchars_alloc , |
|
.Nm mchars_free , |
|
.Nm mchars_num2char , |
|
.Nm mchars_num2uc , |
|
.Nm mchars_spec2cp , |
|
.Nm mchars_spec2str , |
|
.Nm mdoc_meta , |
|
.Nm mdoc_node , |
|
.Nm mparse_alloc , |
.Nm mparse_alloc , |
|
.Nm mparse_copy , |
.Nm mparse_free , |
.Nm mparse_free , |
.Nm mparse_getkeep , |
.Nm mparse_open , |
.Nm mparse_keep , |
|
.Nm mparse_readfd , |
.Nm mparse_readfd , |
.Nm mparse_reset , |
.Nm mparse_reset , |
.Nm mparse_result , |
.Nm mparse_result , |
.Nm mparse_strerror , |
.Nm mparse_strerror , |
.Nm mparse_strlevel |
.Nm mparse_strlevel , |
|
.Nm mparse_updaterc |
.Nd mandoc macro compiler library |
.Nd mandoc macro compiler library |
.Sh LIBRARY |
|
.Lb mandoc |
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.In man.h |
.In sys/types.h |
.In mdoc.h |
|
.In mandoc.h |
.In mandoc.h |
.Ft "enum mandoc_esc" |
.Pp |
.Fo mandoc_escape |
.Fd "#define ASCII_NBRSP" |
.Fa "const char **in" |
.Fd "#define ASCII_HYPH" |
.Fa "const char **seq" |
.Fd "#define ASCII_BREAK" |
.Fa "int *len" |
.Ft struct mparse * |
|
.Fo mparse_alloc |
|
.Fa "int options" |
|
.Fa "enum mandocerr mmin" |
|
.Fa "mandocmsg mmsg" |
|
.Fa "enum mandoc_os oe_e" |
|
.Fa "char *os_s" |
.Fc |
.Fc |
.Ft "const struct man_meta *" |
|
.Fo man_meta |
|
.Fa "const struct man *man" |
|
.Fc |
|
.Ft "const struct mparse *" |
|
.Fo man_mparse |
|
.Fa "const struct man *man" |
|
.Fc |
|
.Ft "const struct man_node *" |
|
.Fo man_node |
|
.Fa "const struct man *man" |
|
.Fc |
|
.Ft "struct mchars *" |
|
.Fn mchars_alloc |
|
.Ft void |
.Ft void |
.Fn mchars_free "struct mchars *p" |
.Fo (*mandocmsg) |
.Ft char |
.Fa "enum mandocerr errtype" |
.Fn mchars_num2char "const char *cp" "size_t sz" |
.Fa "enum mandoclevel level" |
.Ft int |
.Fa "const char *file" |
.Fn mchars_num2uc "const char *cp" "size_t sz" |
.Fa "int line" |
.Ft "const char *" |
.Fa "int col" |
.Fo mchars_spec2str |
.Fa "const char *msg" |
.Fa "struct mchars *p" |
|
.Fa "const char *cp" |
|
.Fa "size_t sz" |
|
.Fa "size_t *rsz" |
|
.Fc |
.Fc |
.Ft int |
|
.Fo mchars_spec2cp |
|
.Fa "struct mchars *p" |
|
.Fa "const char *cp" |
|
.Fa "size_t sz" |
|
.Ft "const char *" |
|
.Fc |
|
.Ft "const struct mdoc_meta *" |
|
.Fo mdoc_meta |
|
.Fa "const struct mdoc *mdoc" |
|
.Fc |
|
.Ft "const struct mdoc_node *" |
|
.Fo mdoc_node |
|
.Fa "const struct mdoc *mdoc" |
|
.Fc |
|
.Ft void |
.Ft void |
.Fo mparse_alloc |
|
.Fa "enum mparset type" |
|
.Fa "enum mandoclevel wlevel" |
|
.Fa "mandocmsg msg" |
|
.Fa "void *msgarg" |
|
.Fc |
|
.Ft void |
|
.Fo mparse_free |
.Fo mparse_free |
.Fa "struct mparse *parse" |
.Fa "struct mparse *parse" |
.Fc |
.Fc |
.Ft void |
.Ft void |
.Fo mparse_getkeep |
.Fo mparse_copy |
.Fa "const struct mparse *parse" |
.Fa "const struct mparse *parse" |
.Fc |
.Fc |
.Ft void |
.Ft int |
.Fo mparse_keep |
.Fo mparse_open |
.Fa "struct mparse *parse" |
.Fa "struct mparse *parse" |
|
.Fa "const char *fname" |
.Fc |
.Fc |
.Ft "enum mandoclevel" |
.Ft "enum mandoclevel" |
.Fo mparse_readfd |
.Fo mparse_readfd |
|
|
.Ft void |
.Ft void |
.Fo mparse_result |
.Fo mparse_result |
.Fa "struct mparse *parse" |
.Fa "struct mparse *parse" |
.Fa "struct mdoc **mdoc" |
.Fa "struct roff_man **man" |
.Fa "struct man **man" |
.Fa "char **sodest" |
.Fc |
.Fc |
.Ft "const char *" |
.Ft "const char *" |
.Fo mparse_strerror |
.Fo mparse_strerror |
|
|
.Fo mparse_strlevel |
.Fo mparse_strlevel |
.Fa "enum mandoclevel" |
.Fa "enum mandoclevel" |
.Fc |
.Fc |
.Vt extern const char * const * man_macronames; |
.Ft void |
|
.Fo mparse_updaterc |
|
.Fa "struct mparse *parse" |
|
.Fa "enum mandoclevel *rc" |
|
.Fc |
|
.In roff.h |
|
.Ft void |
|
.Fo deroff |
|
.Fa "char **dest" |
|
.Fa "const struct roff_node *node" |
|
.Fc |
|
.In sys/types.h |
|
.In mandoc.h |
|
.In mdoc.h |
.Vt extern const char * const * mdoc_argnames; |
.Vt extern const char * const * mdoc_argnames; |
.Vt extern const char * const * mdoc_macronames; |
.Vt extern const char * const * mdoc_macronames; |
.Fd "#define ASCII_NBRSP" |
.Ft void |
.Fd "#define ASCII_HYPH" |
.Fo mdoc_validate |
|
.Fa "struct roff_man *mdoc" |
|
.Fc |
|
.In sys/types.h |
|
.In mandoc.h |
|
.In man.h |
|
.Vt extern const char * const * man_macronames; |
|
.Ft void |
|
.Fo man_validate |
|
.Fa "struct roff_man *man" |
|
.Fc |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm mandoc |
.Nm mandoc |
Line 166 The following describes a general parse sequence: |
|
Line 146 The following describes a general parse sequence: |
|
.Bl -enum |
.Bl -enum |
.It |
.It |
initiate a parsing sequence with |
initiate a parsing sequence with |
|
.Xr mchars_alloc 3 |
|
and |
.Fn mparse_alloc ; |
.Fn mparse_alloc ; |
.It |
.It |
parse files or file descriptors with |
open a file with |
|
.Xr open 2 |
|
or |
|
.Fn mparse_open ; |
|
.It |
|
parse it with |
.Fn mparse_readfd ; |
.Fn mparse_readfd ; |
.It |
.It |
retrieve a parsed syntax tree, if the parse was successful, with |
close it with |
|
.Xr close 2 ; |
|
.It |
|
retrieve the syntax tree with |
.Fn mparse_result ; |
.Fn mparse_result ; |
.It |
.It |
iterate over parse nodes with |
depending on whether the |
.Fn mdoc_node |
.Fa macroset |
|
member of the returned |
|
.Vt struct roff_man |
|
is |
|
.Dv MACROSET_MDOC |
or |
or |
.Fn man_node ; |
.Dv MACROSET_MAN , |
|
validate it with |
|
.Fn mdoc_validate |
|
or |
|
.Fn man_validate , |
|
respectively; |
.It |
.It |
|
if information about the validity of the input is needed, fetch it with |
|
.Fn mparse_updaterc ; |
|
.It |
|
iterate over parse nodes with starting from the |
|
.Fa first |
|
member of the returned |
|
.Vt struct roff_man ; |
|
.It |
free all allocated memory with |
free all allocated memory with |
.Fn mparse_free , |
.Fn mparse_free |
|
and |
|
.Xr mchars_free 3 , |
or invoke |
or invoke |
.Fn mparse_reset |
.Fn mparse_reset |
and parse new files. |
and go back to step 2 to parse new files. |
.El |
.El |
.Pp |
|
The |
|
.Nm |
|
library also contains routines for translating character strings into glyphs |
|
.Pq see Fn mchars_alloc |
|
and parsing escape sequences from strings |
|
.Pq see Fn mandoc_escape . |
|
.Sh REFERENCE |
.Sh REFERENCE |
This section documents the functions, types, and variables available |
This section documents the functions, types, and variables available |
via |
via |
.In mandoc.h . |
.In mandoc.h , |
|
with the exception of those documented in |
|
.Xr mandoc_escape 3 |
|
and |
|
.Xr mchars_alloc 3 . |
.Ss Types |
.Ss Types |
.Bl -ohang |
.Bl -ohang |
.It Vt "enum mandoc_esc" |
|
An escape sequence classification. |
|
.It Vt "enum mandocerr" |
.It Vt "enum mandocerr" |
A fatal error, error, or warning message during parsing. |
An error or warning message during parsing. |
.It Vt "enum mandoclevel" |
.It Vt "enum mandoclevel" |
A classification of an |
A classification of an |
.Vt "enum mandoclevel" |
.Vt "enum mandocerr" |
as regards system operation. |
as regards system operation. |
.It Vt "struct mchars" |
See the DIAGNOSTICS section in |
An opaque pointer to an object allowing for translation between |
.Xr mandoc 1 |
character strings and glyphs. |
regarding the meanings of the levels. |
See |
|
.Fn mchars_alloc . |
|
.It Vt "enum mparset" |
|
The type of parser when reading input. |
|
This should usually be |
|
.Dv MPARSE_AUTO |
|
for auto-detection. |
|
.It Vt "struct mparse" |
.It Vt "struct mparse" |
An opaque pointer to a running parse sequence. |
An opaque pointer to a running parse sequence. |
Created with |
Created with |
Line 226 This may be used across parsed input if |
|
Line 223 This may be used across parsed input if |
|
.Fn mparse_reset |
.Fn mparse_reset |
is called between parses. |
is called between parses. |
.It Vt "mandocmsg" |
.It Vt "mandocmsg" |
A prototype for a function to handle fatal error, error, and warning |
A prototype for a function to handle error and warning |
messages emitted by the parser. |
messages emitted by the parser. |
.El |
.El |
.Ss Functions |
.Ss Functions |
.Bl -ohang |
.Bl -ohang |
.It Fn mandoc_escape |
.It Fn deroff |
Scan an escape sequence, i.e., a character string beginning with |
Obtain a text-only representation of a |
.Sq \e . |
.Vt struct roff_node , |
Pass a pointer to this string as |
including text contained in its child nodes. |
.Va end ; |
To be used on children of the |
it will be set to the supremum of the parsed escape sequence unless |
.Fa first |
returning |
member of |
.Dv ESCAPE_ERROR , |
.Vt struct roff_man . |
in which case the string is bogus and should be |
When it is no longer needed, the pointer returned from |
thrown away. |
.Fn deroff |
If not |
can be passed to |
.Dv ESCAPE_ERROR |
.Xr free 3 . |
or |
.It Fn man_validate |
.Dv ESCAPE_IGNORE , |
Validate the |
.Va start |
.Dv MACROSET_MAN |
is set to the first relevant character of the substring (font, glyph, |
parse tree obtained with |
whatever) of length |
|
.Va sz . |
|
Both |
|
.Va start |
|
and |
|
.Va sz |
|
may be |
|
.Dv NULL . |
|
.It Fn man_meta |
|
Obtain the meta-data of a successful parse. |
|
This may only be used on a pointer returned by |
|
.Fn mparse_result . |
.Fn mparse_result . |
.It Fn man_mparse |
Declared in |
Get the parser used for the current output. |
.In man.h , |
.It Fn man_node |
implemented in |
Obtain the root node of a successful parse. |
.Pa man.c . |
This may only be used on a pointer returned by |
.It Fn mdoc_validate |
|
Validate the |
|
.Dv MACROSET_MDOC |
|
parse tree obtained with |
.Fn mparse_result . |
.Fn mparse_result . |
.It Fn mchars_alloc |
Declared in |
Allocate an |
.In mdoc.h , |
.Vt "struct mchars *" |
implemented in |
object for translating special characters into glyphs. |
.Pa mdoc.c . |
See |
|
.Xr mandoc_char 7 |
|
for an overview of special characters. |
|
The object must be freed with |
|
.Fn mchars_free . |
|
.It Fn mchars_free |
|
Free an object created with |
|
.Fn mchars_alloc . |
|
.It Fn mchars_num2char |
|
Convert a character index (e.g., the \eN\(aq\(aq escape) into a |
|
printable ASCII character. |
|
Returns \e0 (the nil character) if the input sequence is malformed. |
|
.It Fn mchars_num2uc |
|
Convert a hexadecimal character index (e.g., the \e[uNNNN] escape) into |
|
a Unicode codepoint. |
|
Returns \e0 (the nil character) if the input sequence is malformed. |
|
.It Fn mchars_spec2cp |
|
Convert a special character into a valid Unicode codepoint. |
|
Returns \-1 on failure or a non-zero Unicode codepoint on success. |
|
.It Fn mchars_spec2str |
|
Convert a special character into an ASCII string. |
|
Returns |
|
.Dv NULL |
|
on failure. |
|
.It Fn mdoc_meta |
|
Obtain the meta-data of a successful parse. |
|
This may only be used on a pointer returned by |
|
.Fn mparse_result . |
|
.It Fn mdoc_node |
|
Obtain the root node of a successful parse. |
|
This may only be used on a pointer returned by |
|
.Fn mparse_result . |
|
.It Fn mparse_alloc |
.It Fn mparse_alloc |
Allocate a parser. |
Allocate a parser. |
|
The arguments have the following effect: |
|
.Bl -tag -offset 5n -width inttype |
|
.It Ar options |
|
When the |
|
.Dv MPARSE_MDOC |
|
or |
|
.Dv MPARSE_MAN |
|
bit is set, only that parser is used. |
|
Otherwise, the document type is automatically detected. |
|
.Pp |
|
When the |
|
.Dv MPARSE_SO |
|
bit is set, |
|
.Xr roff 7 |
|
.Ic \&so |
|
file inclusion requests are always honoured. |
|
Otherwise, if the request is the only content in an input file, |
|
only the file name is remembered, to be returned in the |
|
.Fa sodest |
|
argument of |
|
.Fn mparse_result . |
|
.Pp |
|
When the |
|
.Dv MPARSE_QUICK |
|
bit is set, parsing is aborted after the NAME section. |
|
This is for example useful in |
|
.Xr makewhatis 8 |
|
.Fl Q |
|
to quickly build minimal databases. |
|
.It Ar mmin |
|
Can be set to |
|
.Dv MANDOCERR_BASE , |
|
.Dv MANDOCERR_STYLE , |
|
.Dv MANDOCERR_WARNING , |
|
.Dv MANDOCERR_ERROR , |
|
.Dv MANDOCERR_UNSUPP , |
|
or |
|
.Dv MANDOCERR_MAX . |
|
Messages below the selected level will be suppressed. |
|
.It Ar mmsg |
|
A callback function to handle errors and warnings. |
|
See |
|
.Pa main.c |
|
for an example. |
|
If printing of error messages is not desired, |
|
.Dv NULL |
|
may be passed. |
|
.It Ar os_e |
|
Operating system to check base system conventions for. |
|
If |
|
.Dv MANDOC_OS_OTHER , |
|
the system is automatically detected from |
|
.Ic \&Os , |
|
.Fl Ios , |
|
or |
|
.Xr uname 3 . |
|
.It Ar os_s |
|
A default string for the |
|
.Xr mdoc 7 |
|
.Ic \&Os |
|
macro, overriding the |
|
.Dv OSNAME |
|
preprocessor definition and the results of |
|
.Xr uname 3 . |
|
Passing |
|
.Dv NULL |
|
sets no default. |
|
.El |
|
.Pp |
The same parser may be used for multiple files so long as |
The same parser may be used for multiple files so long as |
.Fn mparse_reset |
.Fn mparse_reset |
is called between parses. |
is called between parses. |
.Fn mparse_free |
.Fn mparse_free |
must be called to free the memory allocated by this function. |
must be called to free the memory allocated by this function. |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
.It Fn mparse_free |
.It Fn mparse_free |
Free all memory allocated by |
Free all memory allocated by |
.Fn mparse_alloc . |
.Fn mparse_alloc . |
.It Fn mparse_getkeep |
Declared in |
Acquire the keep buffer. |
.In mandoc.h , |
Must follow a call of |
implemented in |
.Fn mparse_keep . |
.Pa read.c . |
.It Fn mparse_keep |
.It Fn mparse_copy |
Instruct the parser to retain a copy of its parsed input. |
Dump a copy of the input to the standard output; used for |
This can be acquired with subsequent |
.Fl man T Ns Cm man . |
.Fn mparse_getkeep |
Declared in |
calls. |
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
|
.It Fn mparse_open |
|
Open the file for reading. |
|
If that fails and |
|
.Fa fname |
|
does not already end in |
|
.Ql .gz , |
|
try again after appending |
|
.Ql .gz . |
|
Save the information whether the file is zipped or not. |
|
Return a file descriptor open for reading or -1 on failure. |
|
It can be passed to |
|
.Fn mparse_readfd |
|
or used directly. |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
.It Fn mparse_readfd |
.It Fn mparse_readfd |
Parse a file or file descriptor. |
Parse a file descriptor opened with |
If |
.Xr open 2 |
.Va fd |
or |
is -1, |
.Fn mparse_open . |
.Va fname |
Pass the associated filename in |
is opened for reading. |
.Va fname . |
Otherwise, |
This function may be called multiple times with different parameters; however, |
.Va fname |
.Xr close 2 |
is assumed to be the name associated with |
and |
.Va fd . |
|
This may be called multiple times with different parameters; however, |
|
.Fn mparse_reset |
.Fn mparse_reset |
should be invoked between parses. |
should be invoked between parses. |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
.It Fn mparse_reset |
.It Fn mparse_reset |
Reset a parser so that |
Reset a parser so that |
.Fn mparse_readfd |
.Fn mparse_readfd |
may be used again. |
may be used again. |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
.It Fn mparse_result |
.It Fn mparse_result |
Obtain the result of a parse. |
Obtain the result of a parse. |
Only successful parses |
One of the two pointers will be filled in. |
.Po |
Declared in |
i.e., those where |
.In mandoc.h , |
.Fn mparse_readfd |
implemented in |
returned less than MANDOCLEVEL_FATAL |
.Pa read.c . |
.Pc |
|
should invoke this function, in which case one of the two pointers will |
|
be filled in. |
|
.It Fn mparse_strerror |
.It Fn mparse_strerror |
Return a statically-allocated string representation of an error code. |
Return a statically-allocated string representation of an error code. |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
.It Fn mparse_strlevel |
.It Fn mparse_strlevel |
Return a statically-allocated string representation of a level code. |
Return a statically-allocated string representation of a level code. |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
|
.It Fn mparse_updaterc |
|
If the highest warning or error level that occurred during the current |
|
.Fa parse |
|
is higher than |
|
.Pf * Fa rc , |
|
update |
|
.Pf * Fa rc |
|
accordingly. |
|
This is useful after calling |
|
.Fn mdoc_validate |
|
or |
|
.Fn man_validate . |
|
Declared in |
|
.In mandoc.h , |
|
implemented in |
|
.Pa read.c . |
.El |
.El |
.Ss Variables |
.Ss Variables |
.Bl -ohang |
.Bl -ohang |
.It Va man_macronames |
.It Va man_macronames |
The string representation of a man macro as indexed by |
The string representation of a |
|
.Xr man 7 |
|
macro as indexed by |
.Vt "enum mant" . |
.Vt "enum mant" . |
.It Va mdoc_argnames |
.It Va mdoc_argnames |
The string representation of a mdoc macro argument as indexed by |
The string representation of an |
|
.Xr mdoc 7 |
|
macro argument as indexed by |
.Vt "enum mdocargt" . |
.Vt "enum mdocargt" . |
.It Va mdoc_macronames |
.It Va mdoc_macronames |
The string representation of a mdoc macro as indexed by |
The string representation of an |
|
.Xr mdoc 7 |
|
macro as indexed by |
.Vt "enum mdoct" . |
.Vt "enum mdoct" . |
.El |
.El |
.Sh IMPLEMENTATION NOTES |
.Sh IMPLEMENTATION NOTES |
Line 388 The following non-printing characters may be embedded |
|
Line 470 The following non-printing characters may be embedded |
|
A non-breaking space character. |
A non-breaking space character. |
.It Dv ASCII_HYPH |
.It Dv ASCII_HYPH |
A soft hyphen. |
A soft hyphen. |
|
.It Dv ASCII_BREAK |
|
A breakable zero-width space. |
.El |
.El |
.Pp |
.Pp |
Escape characters are also passed verbatim into text strings. |
Escape characters are also passed verbatim into text strings. |
Line 395 An escape character is a sequence of characters beginn |
|
Line 479 An escape character is a sequence of characters beginn |
|
backslash |
backslash |
.Pq Sq \e . |
.Pq Sq \e . |
To construct human-readable text, these should be intercepted with |
To construct human-readable text, these should be intercepted with |
.Fn mandoc_escape |
.Xr mandoc_escape 3 |
and converted with one of |
and converted with one the functions described in |
.Fn mchars_num2char , |
.Xr mchars_alloc 3 . |
.Fn mchars_spec2str , |
|
and so on. |
|
.Ss Man Abstract Syntax Tree |
.Ss Man Abstract Syntax Tree |
This AST is governed by the ontological rules dictated in |
This AST is governed by the ontological rules dictated in |
.Xr man 7 |
.Xr man 7 |
and derives its terminology accordingly. |
and derives its terminology accordingly. |
.Pp |
.Pp |
The AST is composed of |
The AST is composed of |
.Vt struct man_node |
.Vt struct roff_node |
nodes with element, root and text types as declared by the |
nodes with element, root and text types as declared by the |
.Va type |
.Va type |
field. |
field. |
Each node also provides its parse point (the |
Each node also provides its parse point (the |
.Va line , |
.Va line , |
.Va sec , |
.Va pos , |
and |
and |
.Va pos |
.Va sec |
fields), its position in the tree (the |
fields), its position in the tree (the |
.Va parent , |
.Va parent , |
.Va child , |
.Va child , |
Line 444 where capitalised non-terminals represent nodes. |
|
Line 526 where capitalised non-terminals represent nodes. |
|
.El |
.El |
.Pp |
.Pp |
The only elements capable of nesting other elements are those with |
The only elements capable of nesting other elements are those with |
next-lint scope as documented in |
next-line scope as documented in |
.Xr man 7 . |
.Xr man 7 . |
.Ss Mdoc Abstract Syntax Tree |
.Ss Mdoc Abstract Syntax Tree |
This AST is governed by the ontological |
This AST is governed by the ontological |
Line 458 are described simply as |
|
Line 540 are described simply as |
|
.Qq elements . |
.Qq elements . |
.Pp |
.Pp |
The AST is composed of |
The AST is composed of |
.Vt struct mdoc_node |
.Vt struct roff_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 |
.Va type |
.Va type |
field. |
field. |
Each node also provides its parse point (the |
Each node also provides its parse point (the |
.Va line , |
.Va line , |
.Va sec , |
.Va pos , |
and |
and |
.Va pos |
.Va sec |
fields), its position in the tree (the |
fields), its position in the tree (the |
.Va parent , |
.Va parent , |
.Va child , |
.Va child , |
.Va nchild , |
.Va last , |
.Va next |
.Va next |
and |
and |
.Va prev |
.Va prev |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
Here, the formatting of the |
Here, the formatting of the |
.Sq \&Ao |
.Ic \&Ao |
block extends from TEXT ao to TEXT ac, |
block extends from TEXT ao to TEXT ac, |
while the formatting of the |
while the formatting of the |
.Sq \&Bo |
.Ic \&Bo |
block extends from TEXT bo to TEXT bc. |
block extends from TEXT bo to TEXT bc. |
It renders as follows in |
It renders as follows in |
.Fl T Ns Cm ascii |
.Fl T Ns Cm ascii |
Line 574 Using badly-nested blocks is |
|
Line 656 Using badly-nested blocks is |
|
.Em strongly discouraged ; |
.Em strongly discouraged ; |
for example, the |
for example, the |
.Fl T Ns Cm html |
.Fl T Ns Cm html |
and |
front-end to |
.Fl T Ns Cm xhtml |
|
front-ends to |
|
.Xr mandoc 1 |
.Xr mandoc 1 |
are unable to render them in any meaningful way. |
is unable to render them in any meaningful way. |
Furthermore, behaviour when encountering badly-nested blocks is not |
Furthermore, behaviour when encountering badly-nested blocks is not |
consistent across troff implementations, especially when using multiple |
consistent across troff implementations, especially when using multiple |
levels of badly-nested blocks. |
levels of badly-nested blocks. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
|
.Xr man.cgi 3 , |
|
.Xr mandoc_escape 3 , |
|
.Xr mandoc_headers 3 , |
|
.Xr mandoc_malloc 3 , |
|
.Xr mansearch 3 , |
|
.Xr mchars_alloc 3 , |
|
.Xr tbl 3 , |
.Xr eqn 7 , |
.Xr eqn 7 , |
.Xr man 7 , |
.Xr man 7 , |
.Xr mandoc_char 7 , |
.Xr mandoc_char 7 , |
Line 591 levels of badly-nested blocks. |
|
Line 678 levels of badly-nested blocks. |
|
.Xr roff 7 , |
.Xr roff 7 , |
.Xr tbl 7 |
.Xr tbl 7 |
.Sh AUTHORS |
.Sh AUTHORS |
|
.An -nosplit |
The |
The |
.Nm |
.Nm |
library was written by |
library was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
.Mt kristaps@bsd.lv . |
and is maintained by |
|
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |