X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/9e21548672490d99d4a59ab449c80b3721689818..0d3c1e62ca62e820e20a744760c2767cee37d5c9:/man.h

diff --git a/man.h b/man.h
index 85d000b3..21c1a321 100644
--- a/man.h
+++ b/man.h
@@ -1,6 +1,6 @@
-/*	$Id: man.h,v 1.15 2009/07/04 09:01:55 kristaps Exp $ */
+/*	$Id: man.h,v 1.45 2010/10/04 07:01:02 kristaps Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010 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,84 +17,111 @@
 #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
+/* 
+ * 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_ROOT,
+	MAN_BLOCK,
+	MAN_HEAD,
+	MAN_BODY
 };
 
+/* 
+ * Information from prologue. 
+ */
 struct	man_meta {
-	int		 msec;
-	time_t		 date;
-	char		*vol;
-	char		*title;
-	char		*source;
+	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;
-	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;
-	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_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 */
 };
 
-#define	MAN_IGN_MACRO	 (1 << 0)
-#define	MAN_IGN_CHARS	 (1 << 1)
-#define	MAN_IGN_ESCAPE	 (1 << 2)
-
+/*
+ * 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;
 
-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);
+struct	man	 *man_alloc(struct regset *, void *, mandocmsg);
+void		  man_reset(struct man *);
+int	 	  man_parseln(struct man *, int, char *, int);
 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 *);