Remove useless DIVs in favour of BRs. Fix `Ex' by having it print a prior

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index d31d20c0b425180d6a6d0679872d1028ace3979c..1bd7c6728f7592285863e2defaccf8562f1db275 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,4 +1,4 @@
-/*     $Id: man.h,v 1.44 2010/10/02 10:14:37 kristaps Exp $ */
+/*     $Id: man.h,v 1.48 2010/12/08 10:58:22 kristaps Exp $ */
 /*
  * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
@@ -17,8 +17,96 @@
 #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_sp,
+       MAN_nf,
+       MAN_fi,
+       MAN_RE,
+       MAN_RS,
+       MAN_DT,
+       MAN_UC,
+       MAN_PD,
+       MAN_AT,
+       MAN_in,
+       MAN_ft,
+       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