Revert merging of {mdoc,man}.h -> mandoc.h.

While I'm add it, properly document all structures in these files.

1 files changed, 93 insertions, 1 deletions

diff --git a/man.h b/man.h
index a7181f5f..4de03fbf 100644
--- a/man.h
+++ b/man.h
@@ -17,8 +17,100 @@
 #ifndef MAN_H
 #define MAN_H
 
-#include <time.h>
+/* 
+ * What follows is a list of ALL possible macros. 
+ */
+enum	mant {
+	MAN_br = 0,
+	MAN_TH,
+	MAN_SH,
+	MAN_SS,
+	MAN_TP,
+	MAN_LP,
+	MAN_PP,
+	MAN_P,
+	MAN_IP,
+	MAN_HP,
+	MAN_SM,
+	MAN_SB,
+	MAN_BI,
+	MAN_IB,
+	MAN_BR,
+	MAN_RB,
+	MAN_R,
+	MAN_B,
+	MAN_I,
+	MAN_IR,
+	MAN_RI,
+	MAN_na,
+	MAN_i,
+	MAN_sp,
+	MAN_nf,
+	MAN_fi,
+	MAN_r,
+	MAN_RE,
+	MAN_RS,
+	MAN_DT,
+	MAN_UC,
+	MAN_PD,
+	MAN_Sp,
+	MAN_Vb,
+	MAN_Ve,
+	MAN_AT,
+	MAN_in,
+	MAN_MAX
+};
+
+/* 
+ * Type of a syntax node. 
+ */
+enum	man_type {
+	MAN_TEXT,
+	MAN_ELEM,
+	MAN_ROOT,
+	MAN_BLOCK,
+	MAN_HEAD,
+	MAN_BODY
+};
+
+/* 
+ * Information from prologue. 
+ */
+struct	man_meta {
+	char		*msec; /* `TH' section (1, 3p, etc.) */
+	time_t		 date; /* `TH' normalised date */
+	char		*rawdate; /* raw `TH' date */
+	char		*vol; /* `TH' volume */
+	char		*title; /* `TH' title (e.g., FOO) */
+	char		*source; /* `TH' source (e.g., GNU) */
+};
 
+/* 
+ * Single node in tree-linked AST. 
+ */
+struct	man_node {
+	struct man_node	*parent; /* parent AST node */
+	struct man_node	*child; /* first child AST node */
+	struct man_node	*next; /* sibling AST node */
+	struct man_node	*prev; /* prior sibling AST node */
+	int		 nchild; /* number children */
+	int		 line;
+	int		 pos;
+	enum mant	 tok; /* tok or MAN__MAX if none */
+	int		 flags;
+#define	MAN_VALID	(1 << 0) /* has been validated */
+#define	MAN_ACTED	(1 << 1) /* has been acted upon */
+#define	MAN_EOS		(1 << 2) /* at sentence boundary */
+	enum man_type	 type; /* AST node type */
+	char		*string; /* TEXT node argument */
+	struct man_node	*head; /* BLOCK node HEAD ptr */
+	struct man_node	*body; /* BLOCK node BODY ptr */
+};
+
+/*
+ * Names of macros.  Index is enum mant.  Indexing into this returns
+ * the normalised name, e.g., man_macronames[MAN_SH] -> "SH".
+ */
 extern	const char *const *man_macronames;
 
 __BEGIN_DECLS