Tag an internal release, 1.10.7, that marks being in sync with OpenBSD's

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index ae9b2814745d7d0f80dbda4369812841d8e76e62..03c93f3e18d0285c0502ae68939eec3f3dec2337 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.32 2010/12/06 16:55:35 kristaps Exp $ */

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


@@ -20,88 +20,164 @@
 #define ASCII_NBRSP     31  /* non-breaking space */
 #define        ASCII_HYPH       30  /* breakable hyphen */
 
 #define ASCII_NBRSP     31  /* non-breaking space */
 #define        ASCII_HYPH       30  /* breakable hyphen */
 

+/*
+ * Status level.  This refers to both internal status (i.e., whilst
+ * running, when warnings/errors are reported) and an indicator of a
+ * threshold of when to halt (when said internal state exceeds the
+ * threshold).
+ */
+enum   mandoclevel {
+       MANDOCLEVEL_OK = 0,
+       MANDOCLEVEL_RESERVED,
+       MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
+       MANDOCLEVEL_ERROR, /* input has been thrown away */
+       MANDOCLEVEL_FATAL, /* input is borked */
+       MANDOCLEVEL_BADARG, /* bad argument in invocation */
+       MANDOCLEVEL_SYSERR, /* system error */
+       MANDOCLEVEL_MAX
+};

 
 

-__BEGIN_DECLS
-
+/*
+ * All possible things that can go wrong within a parse, be it libroff,
+ * libmdoc, or libman.
+ */

 enum   mandocerr {
        MANDOCERR_OK,
 enum   mandocerr {
        MANDOCERR_OK,

-       MANDOCERR_UPPERCASE, /* text should be uppercase */
-       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_BADSTANDARD, /* bad standard */
-       MANDOCERR_BADLIB, /* bad library */
-       MANDOCERR_BADESCAPE, /* bad escape sequence */
-       MANDOCERR_BADQUOTE, /* unterminated quoted string */
-       MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
-       MANDOCERR_WIDTHARG, /* superfluous width argument */
-       MANDOCERR_BADDATE, /* bad date argument */
-       MANDOCERR_BADWIDTH, /* bad width argument */
+
+       MANDOCERR_WARNING, /* ===== start of warnings ===== */
+
+       /* related to the prologue */
+       MANDOCERR_NOTITLE, /* no title in document */
+       MANDOCERR_UPPERCASE, /* document title should be all caps */

        MANDOCERR_BADMSEC, /* unknown manual section */
        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_BADDATE, /* cannot parse date argument */
+       MANDOCERR_PROLOGOOO, /* prologue macros out of order */
+       MANDOCERR_PROLOGREP, /* duplicate prologue macro */
+       MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
+       MANDOCERR_BADBODY, /* macro not allowed in body */

 
 

+       /* related to document structure */
+       MANDOCERR_SO, /* .so is fragile, better use ln(1) */

        MANDOCERR_NAMESECFIRST, /* NAME section must come first */
        MANDOCERR_NAMESECFIRST, /* NAME section must come first */

-       MANDOCERR_BADBOOL, /* bad Boolean value */
-       MANDOCERR_CHILD, /* child violates parent syntax */
-       MANDOCERR_BADATT, /* bad AT&T symbol */
-       MANDOCERR_LISTREP, /* list type repeated */
-       MANDOCERR_DISPREP, /* display type repeated */
-       MANDOCERR_ARGVREP, /* argument repeated */
-       MANDOCERR_NONAME, /* manual name not yet set */
-       MANDOCERR_MACROOBS, /* obsolete macro ignored */
-       MANDOCERR_MACROEMPTY, /* empty macro ignored */
-       MANDOCERR_BADBODY, /* macro not allowed in body */
-       MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
-       MANDOCERR_BADCHAR, /* bad character */

        MANDOCERR_BADNAMESEC, /* bad NAME section contents */
        MANDOCERR_BADNAMESEC, /* bad NAME section contents */

-       MANDOCERR_NOBLANKLN, /* no blank lines */
-       MANDOCERR_NOTEXT, /* no text in this context */
+       MANDOCERR_NONAME, /* manual name not yet set */
+       MANDOCERR_SECOOO, /* sections out of conventional order */
+       MANDOCERR_SECREP, /* duplicate section name */
+       MANDOCERR_SECMSEC, /* section not in conventional manual section */
+
+       /* related to macros and nesting */
+       MANDOCERR_MACROOBS, /* skipping obsolete macro */
+       MANDOCERR_IGNPAR, /* skipping paragraph macro */
+       MANDOCERR_SCOPENEST, /* blocks badly nested */
+       MANDOCERR_CHILD, /* child violates parent syntax */
+       MANDOCERR_NESTEDDISP, /* nested displays are not portable */
+       MANDOCERR_SCOPEREP, /* already in literal mode */
+
+       /* related to missing macro arguments */
+       MANDOCERR_MACROEMPTY, /* skipping empty macro */
+       MANDOCERR_DISPTYPE, /* missing display type */
+       MANDOCERR_LISTFIRST, /* list type must come first */
+       MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
+       MANDOCERR_FONTTYPE, /* missing font type */
+
+       /* related to bad macro arguments */
+       MANDOCERR_IGNARGV, /* skipping argument */
+       MANDOCERR_ARGVREP, /* duplicate argument */
+       MANDOCERR_DISPREP, /* duplicate display type */
+       MANDOCERR_LISTREP, /* duplicate list type */
+       MANDOCERR_BADATT, /* unknown AT&T UNIX version */
+       MANDOCERR_BADBOOL, /* bad Boolean value */
+       MANDOCERR_BADFONT, /* unknown font */
+       MANDOCERR_BADSTANDARD, /* unknown standard specifier */
+       MANDOCERR_BADWIDTH, /* bad width argument */
+
+       /* related to plain text */
+       MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
+       MANDOCERR_BADTAB, /* tab in non-literal context */
+       MANDOCERR_EOLNSPACE, /* end of line whitespace */

        MANDOCERR_BADCOMMENT, /* bad comment style */
        MANDOCERR_BADCOMMENT, /* bad comment style */

-       MANDOCERR_MACRO, /* unknown macro will be lost */
+       MANDOCERR_BADESCAPE, /* unknown escape sequence */
+       MANDOCERR_BADQUOTE, /* unterminated quoted string */
+
+       MANDOCERR_ERROR, /* ===== start of errors ===== */
+
+       MANDOCERR_BADCHAR, /* skipping bad character */
+       MANDOCERR_NOTEXT, /* skipping text before the first section header */
+       MANDOCERR_MACRO, /* skipping unknown macro */
+       MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */

        MANDOCERR_LINESCOPE, /* line scope broken */
        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_SCOPEREP, /* scope already open */
+       MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
+       MANDOCERR_SCOPEBROKEN, /* missing end of block */
+       MANDOCERR_SCOPEEXIT, /* scope open on exit */
+       MANDOCERR_UNAME, /* uname(3) system call failed */

        /* 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) */
        /* 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_ARGSLOST, /* line argument(s) will be lost */
        MANDOCERR_BODYLOST, /* body argument(s) will be lost */
        MANDOCERR_LISTTYPE, /* missing list type */
        MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
        MANDOCERR_BODYLOST, /* body argument(s) will be lost */

-#define        MANDOCERR_ERROR         MANDOCERR_BODYLOST
+
+       MANDOCERR_FATAL, /* ===== start of fatal errors ===== */

 
        MANDOCERR_COLUMNS, /* column syntax is inconsistent */
 
        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_SYNTSCOPE, /* scope broken, syntax violated */
+       MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */

        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_SYNTCHILD, /* child violates parent syntax */
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
        MANDOCERR_SYNTCHILD, /* child violates parent syntax */
        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */

+       MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */

        MANDOCERR_NODOCBODY, /* no document body */
        MANDOCERR_NODOCPROLOG, /* no document prologue */
        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_MEM, /* static buffer exhausted */

        MANDOCERR_MAX
 };
 
        MANDOCERR_MAX
 };
 

-typedef        int     (*mandocmsg)(enum mandocerr, 
-                       void *, int, int, const char *);
+/*
+ * Available registers (set in libroff, accessed elsewhere).
+ */
+enum   regs {
+       REG_nS = 0,
+       REG__MAX
+};
+
+/*
+ * A register (struct reg) can consist of many types: this consists of
+ * normalised types from the original string form.
+ */
+union  regval {
+       unsigned  u; /* unsigned integer */
+};
+
+/*
+ * 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 regval      v; /* parsed data */
+};
+
+/*
+ * 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];
+};
+
+__BEGIN_DECLS
+
+/*
+ * 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