mdocml: Move register information into mandoc.h, which is where it

mdocml: Move register information into mandoc.h, which is where it

[kristaps]

Log Message:
-----------
Move register information into mandoc.h, which is where it should have
been in the first place (mandoc.h contains system-wide declarations).

Modified Files:
--------------
    mdocml:
        mandoc.h
        regs.h

Revision Data
-------------
Index: regs.h
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/regs.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -Lregs.h -Lregs.h -u -p -r1.5 -r1.6
--- regs.h
+++ regs.h
@@ -20,28 +20,6 @@
 
 __BEGIN_DECLS
 
-enum	regs {
-	REG_nS = 0,	/* nS */
-	REG__MAX
-};
-
-struct	reg {
-	int		 set; /* whether set or not */
-	union {
-		unsigned u; /* unsigned integer */
-	} v;
-};
-
-/*
- * Registers are non-scoped state.  These can be manipulated directly in
- * libroff or indirectly in libman or libmdoc by macros.  These should
- * be implemented sparingly (we are NOT roffdoc!) and documented fully
- * in roff.7.
- */
-struct	regset {
-	struct reg	 regs[REG__MAX];
-};
-
 char		 *roff_setstr(const char *, const char *);
 char		 *roff_getstr(const char *);
 char		 *roff_getstrn(const char *, size_t);
Index: mandoc.h
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc.h,v
retrieving revision 1.15
retrieving revision 1.16
diff -Lmandoc.h -Lmandoc.h -u -p -r1.15 -r1.16
--- mandoc.h
+++ mandoc.h
@@ -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 {
@@ -106,8 +109,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
 
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv