Clarified EXIT STATUS sections. Discussed among schwarze@, Thomas, and

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index e8c4dd6024fce19bedfc0d8474b190dec2f12938..b314d8863fa7bcd18937a7bbb308d0155f489118 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.6 2010/05/24 01:41:31 schwarze Exp $ */
+/*     $Id: mandoc.h,v 1.18 2010/08/20 01:02:07 schwarze Exp $ */

 /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
 /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *


@@ -17,30 +17,55 @@
 #ifndef MANDOC_H
 #define MANDOC_H
 
 #ifndef MANDOC_H
 #define MANDOC_H
 

+/*
+ * This contains declarations that are available system-wide.
+ */
+
+#define ASCII_NBRSP     31  /* non-breaking space */
+#define        ASCII_HYPH       30  /* breakable hyphen */
+

 __BEGIN_DECLS
 
 __BEGIN_DECLS
 

+enum   mandoclevel {
+       MANDOCLEVEL_OK = 0,
+       MANDOCLEVEL_RESERVED,
+       MANDOCLEVEL_WARNING,
+       MANDOCLEVEL_ERROR,
+       MANDOCLEVEL_FATAL,
+       MANDOCLEVEL_BADARG,
+       MANDOCLEVEL_SYSERR,
+       MANDOCLEVEL_MAX
+};
+

 enum   mandocerr {
        MANDOCERR_OK,
 enum   mandocerr {
        MANDOCERR_OK,

+
+       MANDOCERR_WARNING, /* ===== end of warnings ===== */
+

        MANDOCERR_UPPERCASE, /* text should be uppercase */
        MANDOCERR_UPPERCASE, /* text should be uppercase */

-       MANDOCERR_SECOOO, /* sections out of conentional order */
+       MANDOCERR_SECOOO, /* sections out of conventional order */

        MANDOCERR_SECREP, /* section name repeats */
        MANDOCERR_PROLOGOOO, /* out of order prologue */
        MANDOCERR_PROLOGREP, /* repeated prologue entry */
        MANDOCERR_LISTFIRST, /* list type must come first */
        MANDOCERR_SECREP, /* section name repeats */
        MANDOCERR_PROLOGOOO, /* out of order prologue */
        MANDOCERR_PROLOGREP, /* repeated prologue entry */
        MANDOCERR_LISTFIRST, /* list type must come first */

-       MANDOCERR_COLUMNS, /* column syntax is inconsistent */

        MANDOCERR_BADSTANDARD, /* bad standard */
        MANDOCERR_BADLIB, /* bad library */
        MANDOCERR_BADSTANDARD, /* bad standard */
        MANDOCERR_BADLIB, /* bad library */

+       MANDOCERR_BADTAB, /* tab in non-literal context */

        MANDOCERR_BADESCAPE, /* bad escape sequence */
        MANDOCERR_BADQUOTE, /* unterminated quoted string */
        MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
        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_WIDTHARG, /* superfluous width argument */

+       MANDOCERR_IGNARGV, /* ignoring argument */

        MANDOCERR_BADDATE, /* bad date argument */
        MANDOCERR_BADWIDTH, /* bad width argument */
        MANDOCERR_BADDATE, /* bad date argument */
        MANDOCERR_BADWIDTH, /* bad width argument */

-       MANDOCERR_BADMSEC, /* unknown manual sction */
+       MANDOCERR_BADMSEC, /* unknown manual section */

        MANDOCERR_SECMSEC, /* section not in conventional manual section */
        MANDOCERR_EOLNSPACE, /* end of line whitespace */
        MANDOCERR_SECMSEC, /* section not in conventional manual section */
        MANDOCERR_EOLNSPACE, /* end of line whitespace */

+       MANDOCERR_SCOPENEST, /* blocks badly nested */

        MANDOCERR_SCOPEEXIT, /* scope open on exit */
        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 */
 
        MANDOCERR_NAMESECFIRST, /* NAME section must come first */
        MANDOCERR_BADBOOL, /* bad Boolean value */


@@ -61,28 +86,28 @@ enum        mandocerr {
        MANDOCERR_BADCOMMENT, /* bad comment style */
        MANDOCERR_MACRO, /* unknown macro will be lost */
        MANDOCERR_LINESCOPE, /* line scope broken */
        MANDOCERR_BADCOMMENT, /* bad comment style */
        MANDOCERR_MACRO, /* unknown macro will be lost */
        MANDOCERR_LINESCOPE, /* line scope broken */

-       MANDOCERR_SCOPE, /* scope broken */

        MANDOCERR_ARGCOUNT, /* argument count wrong */
        MANDOCERR_ARGCOUNT, /* argument count wrong */

-       MANDOCERR_NOSCOPE, /* request scope close w/none open */
+       MANDOCERR_NOSCOPE, /* no such block is open */

        MANDOCERR_SCOPEREP, /* scope already open */
        /* FIXME: merge following with MANDOCERR_ARGCOUNT */
        MANDOCERR_NOARGS, /* macro requires line argument(s) */
        MANDOCERR_NOBODY, /* macro requires body argument(s) */
        MANDOCERR_NOARGV, /* macro requires argument(s) */
        MANDOCERR_NOTITLE, /* no title in document */
        MANDOCERR_SCOPEREP, /* scope already open */
        /* FIXME: merge following with MANDOCERR_ARGCOUNT */
        MANDOCERR_NOARGS, /* macro requires line argument(s) */
        MANDOCERR_NOBODY, /* macro requires body argument(s) */
        MANDOCERR_NOARGV, /* macro requires argument(s) */
        MANDOCERR_NOTITLE, /* no title in document */

+       MANDOCERR_LISTTYPE, /* missing list type */
+       MANDOCERR_DISPTYPE, /* missing display type */
+       MANDOCERR_FONTTYPE, /* missing font type */

        MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
        MANDOCERR_BODYLOST, /* body argument(s) will be lost */
        MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
        MANDOCERR_BODYLOST, /* body argument(s) will be lost */

-#define        MANDOCERR_ERROR         MANDOCERR_BODYLOST

 
 

-       /* 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_LISTTYPE, /* missing list type */
+       MANDOCERR_FATAL, /* ===== end of fatal errors ===== */
+
+       MANDOCERR_COLUMNS, /* column syntax is inconsistent */

        /* FIXME: this should be a MANDOCERR_ERROR */
        MANDOCERR_NESTEDDISP, /* displays may not be nested */
        /* 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_SCOPEFATAL, /* blocks badly nested */
+       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 */
        MANDOCERR_SYNTSCOPE, /* scope broken, syntax violated */
        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */


@@ -90,15 +115,45 @@ enum       mandocerr {
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_NODOCBODY, /* no document body */
        MANDOCERR_NODOCPROLOG, /* no document prologue */
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_NODOCBODY, /* no document body */
        MANDOCERR_NODOCPROLOG, /* no document prologue */

-       MANDOCERR_UTSNAME, /* utsname() system call failed */
-       MANDOCERR_MEM, /* memory exhausted */
-#define        MANDOCERR_FATAL         MANDOCERR_MEM
+       MANDOCERR_UTSNAME, /* utsname system call failed */
+       MANDOCERR_MEM, /* static buffer exhausted */

 
        MANDOCERR_MAX
 };
 
 
        MANDOCERR_MAX
 };
 

-typedef        int     (*mandocmsg)(enum mandocerr, 
-                       void *, int, int, const char *);
+enum   regs {
+       REG_nS = 0,     /* register: nS */
+       REG__MAX
+};
+
+/*
+ * A single register entity.  If "set" is zero, the value of the
+ * register should be the default one, which is per-register.  It's
+ * assumed that callers know which type in "v" corresponds to which
+ * register value.
+ */
+struct reg {
+       int               set; /* whether set or not */
+       union {
+               unsigned  u; /* unsigned integer */
+       } v;
+};
+
+/*
+ * The primary interface to setting register values is in libroff,
+ * although libmdoc and libman from time to time will manipulate
+ * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
+ */
+struct regset {
+       struct reg        regs[REG__MAX];
+};
+
+/*
+ * Callback function for warnings, errors, and fatal errors as they
+ * occur in the compilers libroff, libmdoc, and libman.
+ */
+typedef        int             (*mandocmsg)(enum mandocerr, void *,
+                               int, int, const char *);

 
 __END_DECLS
 
 
 __END_DECLS