]> git.cameronkatri.com Git - mandoc.git/blobdiff - mandoc.h
improve error reporting:
[mandoc.git] / mandoc.h
index ae9b2814745d7d0f80dbda4369812841d8e76e62..121e9d8d868d091144d35d1ceda1ad87c0b6a3a9 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.10 2010/06/03 13:44:36 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.13 2010/06/30 20:32:15 schwarze Exp $ */
 /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
@@ -25,6 +25,9 @@ __BEGIN_DECLS
 
 enum   mandocerr {
        MANDOCERR_OK,
+
+       MANDOCERR_WARNING, /* ===== end of warnings ===== */
+
        MANDOCERR_UPPERCASE, /* text should be uppercase */
        MANDOCERR_SECOOO, /* sections out of conventional order */
        MANDOCERR_SECREP, /* section name repeats */
@@ -36,14 +39,17 @@ enum        mandocerr {
        MANDOCERR_BADESCAPE, /* bad escape sequence */
        MANDOCERR_BADQUOTE, /* unterminated quoted string */
        MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
+       /* FIXME: merge with MANDOCERR_IGNARGV. */
        MANDOCERR_WIDTHARG, /* superfluous width argument */
+       MANDOCERR_IGNARGV, /* ignoring argument */
        MANDOCERR_BADDATE, /* bad date argument */
        MANDOCERR_BADWIDTH, /* bad width argument */
        MANDOCERR_BADMSEC, /* unknown manual section */
        MANDOCERR_SECMSEC, /* section not in conventional manual section */
        MANDOCERR_EOLNSPACE, /* end of line whitespace */
        MANDOCERR_SCOPEEXIT, /* scope open on exit */
-#define        MANDOCERR_WARNING       MANDOCERR_SCOPEEXIT
+
+       MANDOCERR_ERROR, /* ===== end of errors ===== */
 
        MANDOCERR_NAMESECFIRST, /* NAME section must come first */
        MANDOCERR_BADBOOL, /* bad Boolean value */
@@ -74,18 +80,19 @@ enum        mandocerr {
        MANDOCERR_NOARGV, /* macro requires argument(s) */
        MANDOCERR_NOTITLE, /* no title in document */
        MANDOCERR_LISTTYPE, /* missing list type */
+       MANDOCERR_DISPTYPE, /* missing display type */
        MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
        MANDOCERR_BODYLOST, /* body argument(s) will be lost */
-#define        MANDOCERR_ERROR         MANDOCERR_BODYLOST
+
+       MANDOCERR_FATAL, /* ===== end of fatal errors ===== */
 
        MANDOCERR_COLUMNS, /* column syntax is inconsistent */
        /* FIXME: this should be a MANDOCERR_ERROR */
        MANDOCERR_FONTTYPE, /* missing font type */
        /* FIXME: this should be a MANDOCERR_ERROR */
-       MANDOCERR_DISPTYPE, /* missing display type */
-       /* FIXME: this should be a MANDOCERR_ERROR */
        MANDOCERR_NESTEDDISP, /* displays may not be nested */
-       MANDOCERR_SYNTNOSCOPE, /* request scope close w/none open */
+       MANDOCERR_BADDISP, /* unsupported display type */
+       MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */
        MANDOCERR_SYNTSCOPE, /* scope broken, syntax violated */
        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
@@ -93,9 +100,8 @@ enum mandocerr {
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_NODOCBODY, /* no document body */
        MANDOCERR_NODOCPROLOG, /* no document prologue */
-       MANDOCERR_UTSNAME, /* utsname() system call failed */
+       MANDOCERR_UTSNAME, /* utsname system call failed */
        MANDOCERR_MEM, /* memory exhausted */
-#define        MANDOCERR_FATAL         MANDOCERR_MEM
 
        MANDOCERR_MAX
 };