Annotation of mandoc/mandoc.h, Revision 1.15
1.15 ! kristaps 1: /* $Id: mandoc.h,v 1.14 2010/07/01 15:38:56 schwarze Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #ifndef MANDOC_H
18: #define MANDOC_H
1.7 kristaps 19:
20: #define ASCII_NBRSP 31 /* non-breaking space */
21: #define ASCII_HYPH 30 /* breakable hyphen */
22:
1.1 kristaps 23:
24: __BEGIN_DECLS
25:
26: enum mandocerr {
27: MANDOCERR_OK,
1.13 schwarze 28:
29: MANDOCERR_WARNING, /* ===== end of warnings ===== */
30:
1.5 kristaps 31: MANDOCERR_UPPERCASE, /* text should be uppercase */
1.9 kristaps 32: MANDOCERR_SECOOO, /* sections out of conventional order */
1.5 kristaps 33: MANDOCERR_SECREP, /* section name repeats */
34: MANDOCERR_PROLOGOOO, /* out of order prologue */
35: MANDOCERR_PROLOGREP, /* repeated prologue entry */
36: MANDOCERR_LISTFIRST, /* list type must come first */
37: MANDOCERR_BADSTANDARD, /* bad standard */
38: MANDOCERR_BADLIB, /* bad library */
39: MANDOCERR_BADESCAPE, /* bad escape sequence */
40: MANDOCERR_BADQUOTE, /* unterminated quoted string */
41: MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
1.12 kristaps 42: /* FIXME: merge with MANDOCERR_IGNARGV. */
1.5 kristaps 43: MANDOCERR_WIDTHARG, /* superfluous width argument */
1.13 schwarze 44: MANDOCERR_IGNARGV, /* ignoring argument */
1.5 kristaps 45: MANDOCERR_BADDATE, /* bad date argument */
46: MANDOCERR_BADWIDTH, /* bad width argument */
1.9 kristaps 47: MANDOCERR_BADMSEC, /* unknown manual section */
1.5 kristaps 48: MANDOCERR_SECMSEC, /* section not in conventional manual section */
49: MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.14 schwarze 50: MANDOCERR_SCOPENEST, /* blocks badly nested */
1.1 kristaps 51: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.13 schwarze 52:
53: MANDOCERR_ERROR, /* ===== end of errors ===== */
1.4 kristaps 54:
1.5 kristaps 55: MANDOCERR_NAMESECFIRST, /* NAME section must come first */
56: MANDOCERR_BADBOOL, /* bad Boolean value */
57: MANDOCERR_CHILD, /* child violates parent syntax */
58: MANDOCERR_BADATT, /* bad AT&T symbol */
59: MANDOCERR_LISTREP, /* list type repeated */
60: MANDOCERR_DISPREP, /* display type repeated */
61: MANDOCERR_ARGVREP, /* argument repeated */
62: MANDOCERR_NONAME, /* manual name not yet set */
63: MANDOCERR_MACROOBS, /* obsolete macro ignored */
64: MANDOCERR_MACROEMPTY, /* empty macro ignored */
65: MANDOCERR_BADBODY, /* macro not allowed in body */
66: MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
67: MANDOCERR_BADCHAR, /* bad character */
68: MANDOCERR_BADNAMESEC, /* bad NAME section contents */
69: MANDOCERR_NOBLANKLN, /* no blank lines */
70: MANDOCERR_NOTEXT, /* no text in this context */
71: MANDOCERR_BADCOMMENT, /* bad comment style */
72: MANDOCERR_MACRO, /* unknown macro will be lost */
73: MANDOCERR_LINESCOPE, /* line scope broken */
74: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.14 schwarze 75: MANDOCERR_NOSCOPE, /* no such block is open */
1.5 kristaps 76: MANDOCERR_SCOPEREP, /* scope already open */
77: /* FIXME: merge following with MANDOCERR_ARGCOUNT */
78: MANDOCERR_NOARGS, /* macro requires line argument(s) */
79: MANDOCERR_NOBODY, /* macro requires body argument(s) */
80: MANDOCERR_NOARGV, /* macro requires argument(s) */
81: MANDOCERR_NOTITLE, /* no title in document */
1.10 kristaps 82: MANDOCERR_LISTTYPE, /* missing list type */
1.11 kristaps 83: MANDOCERR_DISPTYPE, /* missing display type */
1.15 ! kristaps 84: MANDOCERR_FONTTYPE, /* missing font type */
1.5 kristaps 85: MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
86: MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.13 schwarze 87:
88: MANDOCERR_FATAL, /* ===== end of fatal errors ===== */
1.1 kristaps 89:
1.8 kristaps 90: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.5 kristaps 91: /* FIXME: this should be a MANDOCERR_ERROR */
92: MANDOCERR_NESTEDDISP, /* displays may not be nested */
1.11 kristaps 93: MANDOCERR_BADDISP, /* unsupported display type */
1.14 schwarze 94: MANDOCERR_SCOPEFATAL, /* blocks badly nested */
1.13 schwarze 95: MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */
1.5 kristaps 96: MANDOCERR_SYNTSCOPE, /* scope broken, syntax violated */
97: MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
98: MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
99: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
100: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
101: MANDOCERR_NODOCBODY, /* no document body */
102: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.13 schwarze 103: MANDOCERR_UTSNAME, /* utsname system call failed */
1.1 kristaps 104: MANDOCERR_MEM, /* memory exhausted */
105:
106: MANDOCERR_MAX
107: };
108:
109: typedef int (*mandocmsg)(enum mandocerr,
110: void *, int, int, const char *);
111:
112: __END_DECLS
113:
114: #endif /*!MANDOC_H*/
CVSweb