Add some documentation and clean up mdoc.h/man.h.

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index 739cf8bab63918414a3cf97d7c12a5bbb70a2095..4a9b87e5cb79fa4fd85da0352b30c24dd44ec16b 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,6 +1,6 @@
-/*     $Id: man.h,v 1.33 2010/05/16 10:59:36 kristaps Exp $ */
+/*     $Id: man.h,v 1.57 2011/03/22 13:28:22 kristaps Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -17,8 +17,6 @@
 #ifndef MAN_H
 #define MAN_H
 
-#include <time.h>
-
 enum   mant {
        MAN_br = 0,
        MAN_TH,
@@ -42,19 +40,17 @@ enum        mant {
        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_ft,
        MAN_MAX
 };
 
@@ -64,56 +60,47 @@ enum        man_type {
        MAN_ROOT,
        MAN_BLOCK,
        MAN_HEAD,
-       MAN_BODY
+       MAN_BODY,
+       MAN_TBL,
+       MAN_EQN
 };
 
 struct man_meta {
-       char            *msec;
-       time_t           date;
-       char            *vol;
-       char            *title;
-       char            *source;
+       char            *msec; /* `TH' section (1, 3p, etc.) */
+       char            *date; /* `TH' normalised date */
+       char            *vol; /* `TH' volume */
+       char            *title; /* `TH' title (e.g., FOO) */
+       char            *source; /* `TH' source (e.g., GNU) */
 };
 
 struct man_node {
-       struct man_node *parent;
-       struct man_node *child;
-       struct man_node *next;
-       struct man_node *prev;
-       int              nchild;
+       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;
+       enum mant        tok; /* tok or MAN__MAX if none */
        int              flags;
-#define        MAN_VALID       (1 << 0)
-#define        MAN_ACTED       (1 << 1)
-#define        MAN_EOS         (1 << 2)
-       enum man_type    type;
-       char            *string;
-       struct man_node *head;
-       struct man_node *body;
+#define        MAN_VALID       (1 << 0) /* has been validated */
+#define        MAN_EOS         (1 << 2) /* at sentence boundary */
+#define        MAN_LINE        (1 << 3) /* first macro/text on line */
+       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 */
+       const struct tbl_span *span; /* TBL */
+       const struct eqn *eqn; /* EQN */
 };
 
-#define        MAN_IGN_MACRO    (1 << 0)
-#define        MAN_IGN_ESCAPE   (1 << 2)
-
+/* Names of macros.  Index is enum mant. */
 extern const char *const *man_macronames;
 
-struct man_cb {
-       int     (*man_warn)(void *, int, int, const char *);
-       int     (*man_err)(void *, int, int, const char *);
-};
-
 __BEGIN_DECLS
 
 struct man;
 
-void             man_free(struct man *);
-struct man      *man_alloc(void *, int, const struct man_cb *);
-void             man_reset(struct man *);
-int              man_parseln(struct man *, int, char *, int);
-int              man_endparse(struct man *);
-
 const struct man_node *man_node(const struct man *);
 const struct man_meta *man_meta(const struct man *);