Implement the roff(7) .rr (remove register) request.

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index 0efbebdc7cf10bfa38f890e54598f7e389c76a80..26c2747bf3e78de747306632ef16aa3136d60bf5 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,6 +1,7 @@
-/*     $Id: man.h,v 1.13 2009/06/16 19:55:28 kristaps Exp $ */
+/*     $Id: man.h,v 1.64 2014/03/30 19:47:48 schwarze Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -17,84 +18,102 @@
 #ifndef MAN_H
 #define MAN_H
 
-#include <time.h>
-
-#define        MAN_br           0
-#define        MAN_TH           1
-#define        MAN_SH           2
-#define        MAN_SS           3
-#define        MAN_TP           4
-#define        MAN_LP           5
-#define        MAN_PP           6
-#define        MAN_P            7
-#define        MAN_IP           8
-#define        MAN_HP           9
-#define        MAN_SM           10
-#define        MAN_SB           11
-#define        MAN_BI           12
-#define        MAN_IB           13
-#define        MAN_BR           14
-#define        MAN_RB           15
-#define        MAN_R            16
-#define        MAN_B            17
-#define        MAN_I            18
-#define        MAN_IR           19
-#define        MAN_RI           20
-#define        MAN_na           21
-#define        MAN_i            22
-#define        MAN_MAX          23
+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_OP,
+       MAN_EX,
+       MAN_EE,
+       MAN_UR,
+       MAN_UE,
+       MAN_ll,
+       MAN_MAX
+};
 
 enum   man_type {
        MAN_TEXT,
        MAN_ELEM,
-       MAN_ROOT
+       MAN_ROOT,
+       MAN_BLOCK,
+       MAN_HEAD,
+       MAN_BODY,
+       MAN_TAIL,
+       MAN_TBL,
+       MAN_EQN
 };
 
 struct man_meta {
-       int              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;
+       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;
-       int              tok;
+       enum mant        tok; /* tok or MAN__MAX if none */
        int              flags;
-#define        MAN_VALID       (1 << 0)
-#define        MAN_ACTED       (1 << 1)
-       enum man_type    type;
-       char            *string;
+#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 *tail; /* BLOCK node TAIL 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) /* Ignore unknown macros. */
-
+/* 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 *);
-int              man_reset(struct man *);
-int              man_parseln(struct man *, int, char *buf);
-int              man_endparse(struct man *);
-int              man_valid_post(struct man *);
-
 const struct man_node *man_node(const struct man *);
 const struct man_meta *man_meta(const struct man *);
+const struct mparse   *man_mparse(const struct man *);
+void man_deroff(char **, const struct man_node *);
 
 __END_DECLS