Added mail archive periodically generated by hypermail.

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 94af3741a6182c5c7ca8ddefdc9fea1920ea59ca..2fbc0d5bb4eb4d57d98bc73e84bd01d2638efcc8 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,4 +1,4 @@
-/*     $Id: mandoc.h,v 1.15 2010/07/02 12:54:33 kristaps Exp $ */
+/*     $Id: mandoc.h,v 1.17 2010/07/20 14:56:42 kristaps Exp $ */
 /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
@@ -17,10 +17,13 @@
 #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
 
 enum   mandocerr {
@@ -36,6 +39,7 @@ enum  mandocerr {
        MANDOCERR_LISTFIRST, /* list type must come first */
        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 */
@@ -106,8 +110,39 @@ enum       mandocerr {
        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