Annotation of mandoc/mandoc.3, Revision 1.10
1.10 ! kristaps 1: .\" $Id: mandoc.3,v 1.9 2011/05/24 21:31:23 kristaps Exp $
1.1 kristaps 2: .\"
3: .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4: .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
9: .\"
10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: .\"
1.10 ! kristaps 18: .Dd $Mdocdate: May 24 2011 $
1.1 kristaps 19: .Dt MANDOC 3
20: .Os
21: .Sh NAME
22: .Nm mandoc ,
1.3 kristaps 23: .Nm mandoc_escape ,
1.1 kristaps 24: .Nm man_meta ,
25: .Nm man_node ,
1.6 kristaps 26: .Nm mchars_alloc ,
27: .Nm mchars_free ,
28: .Nm mchars_num2char ,
1.7 kristaps 29: .Nm mchars_num2uc ,
1.6 kristaps 30: .Nm mchars_spec2cp ,
31: .Nm mchars_spec2str ,
1.1 kristaps 32: .Nm mdoc_meta ,
33: .Nm mdoc_node ,
34: .Nm mparse_alloc ,
35: .Nm mparse_free ,
36: .Nm mparse_readfd ,
37: .Nm mparse_reset ,
1.2 kristaps 38: .Nm mparse_result ,
39: .Nm mparse_strerror ,
40: .Nm mparse_strlevel
1.1 kristaps 41: .Nd mandoc macro compiler library
1.8 kristaps 42: .Sh LIBRARY
43: .Lb mandoc
1.1 kristaps 44: .Sh SYNOPSIS
45: .In man.h
46: .In mdoc.h
47: .In mandoc.h
1.3 kristaps 48: .Ft "enum mandoc_esc"
49: .Fo mandoc_escape
50: .Fa "const char **in"
51: .Fa "const char **seq"
52: .Fa "int *len"
53: .Fc
1.1 kristaps 54: .Ft "const struct man_meta *"
55: .Fo man_meta
56: .Fa "const struct man *man"
57: .Fc
58: .Ft "const struct man_node *"
59: .Fo man_node
60: .Fa "const struct man *man"
61: .Fc
1.6 kristaps 62: .Ft "struct mchars *"
63: .Fn mchars_alloc
64: .Ft void
65: .Fn mchars_free "struct mchars *p"
66: .Ft char
67: .Fn mchars_num2char "const char *cp" "size_t sz"
1.7 kristaps 68: .Ft int
69: .Fn mchars_num2uc "const char *cp" "size_t sz"
1.6 kristaps 70: .Ft "const char *"
71: .Fo mchars_spec2str
72: .Fa "struct mchars *p"
73: .Fa "const char *cp"
74: .Fa "size_t sz"
75: .Fa "size_t *rsz"
76: .Fc
77: .Ft int
78: .Fo mchars_spec2cp
79: .Fa "struct mchars *p"
80: .Fa "const char *cp"
81: .Fa "size_t sz"
82: .Ft "const char *"
83: .Fc
1.1 kristaps 84: .Ft "const struct mdoc_meta *"
85: .Fo mdoc_meta
86: .Fa "const struct mdoc *mdoc"
87: .Fc
88: .Ft "const struct mdoc_node *"
89: .Fo mdoc_node
90: .Fa "const struct mdoc *mdoc"
91: .Fc
92: .Ft void
93: .Fo mparse_alloc
94: .Fa "enum mparset type"
95: .Fa "enum mandoclevel wlevel"
96: .Fa "mandocmsg msg"
97: .Fa "void *msgarg"
98: .Fc
99: .Ft void
100: .Fo mparse_free
101: .Fa "struct mparse *parse"
102: .Fc
103: .Ft "enum mandoclevel"
104: .Fo mparse_readfd
105: .Fa "struct mparse *parse"
106: .Fa "int fd"
107: .Fa "const char *fname"
108: .Fc
109: .Ft void
110: .Fo mparse_reset
111: .Fa "struct mparse *parse"
112: .Fc
113: .Ft void
114: .Fo mparse_result
115: .Fa "struct mparse *parse"
116: .Fa "struct mdoc **mdoc"
117: .Fa "struct man **man"
1.2 kristaps 118: .Fc
119: .Ft "const char *"
120: .Fo mparse_strerror
121: .Fa "enum mandocerr"
122: .Fc
123: .Ft "const char *"
124: .Fo mparse_strlevel
125: .Fa "enum mandoclevel"
1.1 kristaps 126: .Fc
127: .Vt extern const char * const * man_macronames;
128: .Vt extern const char * const * mdoc_argnames;
129: .Vt extern const char * const * mdoc_macronames;
1.4 kristaps 130: .Fd "#define ASCII_NBRSP"
131: .Fd "#define ASCII_HYPH"
1.1 kristaps 132: .Sh DESCRIPTION
133: The
134: .Nm mandoc
135: library parses a
136: .Ux
137: manual into an abstract syntax tree (AST).
138: .Ux
139: manuals are composed of
140: .Xr mdoc 7
141: or
142: .Xr man 7 ,
143: and may be mixed with
144: .Xr roff 7 ,
145: .Xr tbl 7 ,
146: and
147: .Xr eqn 7
148: invocations.
149: .Pp
150: The following describes a general parse sequence:
151: .Bl -enum
152: .It
153: initiate a parsing sequence with
154: .Fn mparse_alloc ;
155: .It
156: parse files or file descriptors with
157: .Fn mparse_readfd ;
158: .It
159: retrieve a parsed syntax tree, if the parse was successful, with
160: .Fn mparse_result ;
161: .It
162: iterate over parse nodes with
163: .Fn mdoc_node
164: or
165: .Fn man_node ;
166: .It
167: free all allocated memory with
168: .Fn mparse_free ,
169: or invoke
170: .Fn mparse_reset
171: and parse new files.
1.3 kristaps 172: .El
1.6 kristaps 173: .Pp
174: The
175: .Nm
176: library also contains routines for translating character strings into glyphs
177: .Pq see Fn mchars_alloc
178: and parsing escape sequences from strings
179: .Pq see Fn mandoc_escape .
1.7 kristaps 180: .Pp
181: This library is
182: .Ud
1.3 kristaps 183: .Sh REFERENCE
184: This section documents the functions, types, and variables available
185: via
186: .In mandoc.h .
187: .Ss Types
188: .Bl -ohang
189: .It Vt "enum mandoc_esc"
190: .It Vt "enum mandocerr"
191: .It Vt "enum mandoclevel"
1.6 kristaps 192: .It Vt "struct mchars"
193: An opaque pointer to an object allowing for translation between
194: character strings and glyphs.
195: See
196: .Fn mchars_alloc .
1.3 kristaps 197: .It Vt "enum mparset"
198: .It Vt "struct mparse"
199: .It Vt "mandocmsg"
200: .El
201: .Ss Functions
202: .Bl -ohang
203: .It Fn mandoc_escape
1.4 kristaps 204: Scan an escape sequence, i.e., a character string beginning with
205: .Sq \e .
206: Pass a pointer to this string as
207: .Va end ;
208: it will be set to the supremum of the parsed escape sequence unless
209: returning ESCAPE_ERROR, in which case the string is bogus and should be
210: thrown away.
211: If not ESCAPE_ERROR or ESCAPE_IGNORE,
212: .Va start
213: is set to the first relevant character of the substring (font, glyph,
214: whatever) of length
215: .Va sz .
216: Both
217: .Va start
218: and
219: .Va sz
220: may be NULL.
1.3 kristaps 221: .It Fn man_meta
1.4 kristaps 222: Obtain the meta-data of a successful parse.
223: This may only be used on a pointer returned by
224: .Fn mparse_result .
1.3 kristaps 225: .It Fn man_node
1.4 kristaps 226: Obtain the root node of a successful parse.
227: This may only be used on a pointer returned by
228: .Fn mparse_result .
1.6 kristaps 229: .It Fn mchars_alloc
230: Allocate an
231: .Vt "struct mchars *"
232: object for translating special characters into glyphs.
233: See
234: .Xr mandoc_char 7
235: for an overview of special characters.
236: The object must be freed with
237: .Fn mchars_free .
238: .It Fn mchars_free
239: Free an object created with
240: .Fn mchars_alloc .
241: .It Fn mchars_num2char
1.7 kristaps 242: Convert a character index (e.g., the \eN\(aq\(aq escape) into a
243: printable ASCII character.
244: Returns \e0 (the nil character) if the input sequence is malformed.
245: .It Fn mchars_num2uc
246: Convert a hexadecimal character index (e.g., the \e[uNNNN] escape) into
247: a Unicode codepoint.
1.6 kristaps 248: Returns \e0 (the nil character) if the input sequence is malformed.
249: .It Fn mchars_spec2cp
250: Convert a special character into a valid Unicode codepoint.
1.10 ! kristaps 251: Returns \-1 on failure or a non-zero Unicode codepoint on success.
1.6 kristaps 252: .It Fn mchars_spec2str
253: Convert a special character into an ASCII string.
254: Returns NULL on failure.
1.3 kristaps 255: .It Fn mdoc_meta
1.4 kristaps 256: Obtain the meta-data of a successful parse.
257: This may only be used on a pointer returned by
258: .Fn mparse_result .
1.3 kristaps 259: .It Fn mdoc_node
1.4 kristaps 260: Obtain the root node of a successful parse.
261: This may only be used on a pointer returned by
262: .Fn mparse_result .
1.3 kristaps 263: .It Fn mparse_alloc
1.4 kristaps 264: Allocate a parser.
265: The same parser may be used for multiple files so long as
266: .Fn mparse_reset
267: is called between parses.
268: .Fn mparse_free
269: must be called to free the memory allocated by this function.
1.3 kristaps 270: .It Fn mparse_free
1.4 kristaps 271: Free all memory allocated by
272: .Fn mparse_alloc .
1.3 kristaps 273: .It Fn mparse_readfd
1.4 kristaps 274: Parse a file or file descriptor.
275: If
276: .Va fd
277: is -1,
278: .Va fname
279: is opened for reading.
280: Otherwise,
281: .Va fname
282: is assumed to be the name associated with
283: .Va fd .
284: This may be called multiple times with different parameters; however,
285: .Fn mparse_reset
286: should be invoked between parses.
1.3 kristaps 287: .It Fn mparse_reset
1.4 kristaps 288: Reset a parser so that
289: .Fn mparse_readfd
290: may be used again.
1.3 kristaps 291: .It Fn mparse_result
1.4 kristaps 292: Obtain the result of a parse.
293: Only successful parses
294: .Po
295: i.e., those where
296: .Fn mparse_readfd
297: returned less than MANDOCLEVEL_FATAL
298: .Pc
299: should invoke this function, in which case one of the two pointers will
300: be filled in.
1.3 kristaps 301: .It Fn mparse_strerror
1.4 kristaps 302: Return a statically-allocated string representation of an error code.
1.3 kristaps 303: .It Fn mparse_strlevel
1.4 kristaps 304: Return a statically-allocated string representation of a level code.
1.3 kristaps 305: .El
306: .Ss Variables
307: .Bl -ohang
308: .It Va man_macronames
1.4 kristaps 309: The string representation of a man macro as indexed by
310: .Vt "enum mant" .
1.3 kristaps 311: .It Va mdoc_argnames
1.4 kristaps 312: The string representation of a mdoc macro argument as indexed by
313: .Vt "enum mdocargt" .
1.3 kristaps 314: .It Va mdoc_macronames
1.4 kristaps 315: The string representation of a mdoc macro as indexed by
316: .Vt "enum mdoct" .
1.1 kristaps 317: .El
318: .Sh IMPLEMENTATION NOTES
319: This section consists of structural documentation for
320: .Xr mdoc 7
321: and
322: .Xr man 7
323: syntax trees.
324: .Ss Man Abstract Syntax Tree
325: This AST is governed by the ontological rules dictated in
326: .Xr man 7
327: and derives its terminology accordingly.
328: .Pp
329: The AST is composed of
330: .Vt struct man_node
331: nodes with element, root and text types as declared by the
332: .Va type
333: field.
334: Each node also provides its parse point (the
335: .Va line ,
336: .Va sec ,
337: and
338: .Va pos
339: fields), its position in the tree (the
340: .Va parent ,
341: .Va child ,
342: .Va next
343: and
344: .Va prev
345: fields) and some type-specific data.
346: .Pp
347: The tree itself is arranged according to the following normal form,
348: where capitalised non-terminals represent nodes.
349: .Pp
350: .Bl -tag -width "ELEMENTXX" -compact
351: .It ROOT
352: \(<- mnode+
353: .It mnode
354: \(<- ELEMENT | TEXT | BLOCK
355: .It BLOCK
356: \(<- HEAD BODY
357: .It HEAD
358: \(<- mnode*
359: .It BODY
360: \(<- mnode*
361: .It ELEMENT
362: \(<- ELEMENT | TEXT*
363: .It TEXT
364: \(<- [[:alpha:]]*
365: .El
366: .Pp
367: The only elements capable of nesting other elements are those with
368: next-lint scope as documented in
369: .Xr man 7 .
370: .Ss Mdoc Abstract Syntax Tree
371: This AST is governed by the ontological
372: rules dictated in
373: .Xr mdoc 7
374: and derives its terminology accordingly.
375: .Qq In-line
376: elements described in
377: .Xr mdoc 7
378: are described simply as
379: .Qq elements .
380: .Pp
381: The AST is composed of
382: .Vt struct mdoc_node
383: nodes with block, head, body, element, root and text types as declared
384: by the
385: .Va type
386: field.
387: Each node also provides its parse point (the
388: .Va line ,
389: .Va sec ,
390: and
391: .Va pos
392: fields), its position in the tree (the
393: .Va parent ,
394: .Va child ,
395: .Va nchild ,
396: .Va next
397: and
398: .Va prev
399: fields) and some type-specific data, in particular, for nodes generated
400: from macros, the generating macro in the
401: .Va tok
402: field.
403: .Pp
404: The tree itself is arranged according to the following normal form,
405: where capitalised non-terminals represent nodes.
406: .Pp
407: .Bl -tag -width "ELEMENTXX" -compact
408: .It ROOT
409: \(<- mnode+
410: .It mnode
411: \(<- BLOCK | ELEMENT | TEXT
412: .It BLOCK
413: \(<- HEAD [TEXT] (BODY [TEXT])+ [TAIL [TEXT]]
414: .It ELEMENT
415: \(<- TEXT*
416: .It HEAD
417: \(<- mnode*
418: .It BODY
419: \(<- mnode* [ENDBODY mnode*]
420: .It TAIL
421: \(<- mnode*
422: .It TEXT
423: \(<- [[:printable:],0x1e]*
424: .El
425: .Pp
426: Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
427: the BLOCK production: these refer to punctuation marks.
428: Furthermore, although a TEXT node will generally have a non-zero-length
429: string, in the specific case of
430: .Sq \&.Bd \-literal ,
431: an empty line will produce a zero-length string.
432: Multiple body parts are only found in invocations of
433: .Sq \&Bl \-column ,
434: where a new body introduces a new phrase.
435: .Pp
436: The
437: .Xr mdoc 7
1.5 kristaps 438: syntax tree accommodates for broken block structures as well.
1.1 kristaps 439: The ENDBODY node is available to end the formatting associated
440: with a given block before the physical end of that block.
441: It has a non-null
442: .Va end
443: field, is of the BODY
444: .Va type ,
445: has the same
446: .Va tok
447: as the BLOCK it is ending, and has a
448: .Va pending
449: field pointing to that BLOCK's BODY node.
450: It is an indirect child of that BODY node
451: and has no children of its own.
452: .Pp
453: An ENDBODY node is generated when a block ends while one of its child
454: blocks is still open, like in the following example:
455: .Bd -literal -offset indent
456: \&.Ao ao
457: \&.Bo bo ac
458: \&.Ac bc
459: \&.Bc end
460: .Ed
461: .Pp
462: This example results in the following block structure:
463: .Bd -literal -offset indent
464: BLOCK Ao
465: HEAD Ao
466: BODY Ao
467: TEXT ao
468: BLOCK Bo, pending -> Ao
469: HEAD Bo
470: BODY Bo
471: TEXT bo
472: TEXT ac
473: ENDBODY Ao, pending -> Ao
474: TEXT bc
475: TEXT end
476: .Ed
477: .Pp
478: Here, the formatting of the
479: .Sq \&Ao
480: block extends from TEXT ao to TEXT ac,
481: while the formatting of the
482: .Sq \&Bo
483: block extends from TEXT bo to TEXT bc.
484: It renders as follows in
485: .Fl T Ns Cm ascii
486: mode:
487: .Pp
488: .Dl <ao [bo ac> bc] end
489: .Pp
490: Support for badly-nested blocks is only provided for backward
491: compatibility with some older
492: .Xr mdoc 7
493: implementations.
494: Using badly-nested blocks is
495: .Em strongly discouraged ;
496: for example, the
497: .Fl T Ns Cm html
498: and
499: .Fl T Ns Cm xhtml
500: front-ends to
501: .Xr mandoc 1
502: are unable to render them in any meaningful way.
503: Furthermore, behaviour when encountering badly-nested blocks is not
504: consistent across troff implementations, especially when using multiple
505: levels of badly-nested blocks.
506: .Sh SEE ALSO
507: .Xr mandoc 1 ,
508: .Xr eqn 7 ,
509: .Xr man 7 ,
1.6 kristaps 510: .Xr mandoc_char 7 ,
1.1 kristaps 511: .Xr mdoc 7 ,
512: .Xr roff 7 ,
513: .Xr tbl 7
514: .Sh AUTHORS
515: The
516: .Nm
517: library was written by
518: .An Kristaps Dzonsons Aq kristaps@bsd.lv .
CVSweb