summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-07-05 20:10:22 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-07-05 20:10:22 +0000
commitfe1a53038c9903e07bd970d56c84c38cf91ae7ab (patch)
tree6b53a5129bddcf104f2ea5a1310a1294c4d5d348
parentce83189251ba5b38af62f3cabfefe075d9a6652c (diff)
downloadmandoc-fe1a53038c9903e07bd970d56c84c38cf91ae7ab.tar.gz
Move register information into mandoc.h, which is where it should have
been in the first place (mandoc.h contains system-wide declarations).
-rw-r--r--mandoc.h40
-rw-r--r--regs.h22
2 files changed, 37 insertions, 25 deletions
diff --git a/mandoc.h b/mandoc.h
index 3e010bc2..8b3dd794 100644
--- a/mandoc.h
+++ b/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
diff --git a/regs.h b/regs.h
index 8035928d..0ea946e2 100644
--- a/regs.h
+++ b/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);