===================================================================
RCS file: /cvs/mandoc/mdoc.h,v
retrieving revision 1.2
retrieving revision 1.25
diff -u -p -r1.2 -r1.25
--- mandoc/mdoc.h	2008/12/15 03:13:01	1.2
+++ mandoc/mdoc.h	2009/01/17 16:15:27	1.25
@@ -1,4 +1,4 @@
-/* $Id: mdoc.h,v 1.2 2008/12/15 03:13:01 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.25 2009/01/17 16:15:27 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -19,7 +19,7 @@
 #ifndef MDOC_H
 #define MDOC_H
 
-#define	MDOC_LINEARG_MAX 9
+/* What follows is a list of ALL possible macros. */
 
 #define	MDOC___	 	 0
 #define	MDOC_Dd		 1
@@ -129,6 +129,8 @@
 #define	MDOC_Ud		 105
 #define	MDOC_MAX	 106
 
+/* What follows is a list of ALL possible macro arguments. */
+
 #define	MDOC_Split	 0
 #define	MDOC_Nosplit	 1
 #define	MDOC_Ragged	 2
@@ -189,38 +191,68 @@
 #define MDOC_svid4	 57
 #define	MDOC_Filled	 58
 #define	MDOC_Words	 59
-#define	MDOC_ARG_MAX	 60
+#define	MDOC_Emphasis	 60
+#define	MDOC_Symbolic	 61
+#define	MDOC_ARG_MAX	 62
 
-enum 	mdoc_err {
-	ERR_SYNTAX_QUOTE,
-	ERR_SYNTAX_WS,
-	ERR_MACRO_NOTSUP,
-	ERR_MACRO_NOTCALL,
-	ERR_SCOPE_BREAK,
-	ERR_ARGS_GE1
+enum	mdoc_warn {
+	WARN_SYNTAX,		/* Syntax warn (at line/col). */
+	WARN_COMPAT		/* Groff compat warn (at line/col). */
 };
 
-enum	mdoc_warn {
-	WARN_SYNTAX_WS_EOLN,
-	WARN_SYNTAX_MACLIKE,
-	WARN_ARGS_GE1
+/* Possible values for the `At' macro. */
+enum	mdoc_att {
+	ATT_DEFAULT = 0,
+	ATT_v1,
+	ATT_v2,
+	ATT_v3,
+	ATT_v4,
+	ATT_v5,
+	ATT_v6,
+	ATT_v7,
+	ATT_32v,
+	ATT_V1,
+	ATT_V2,
+	ATT_V3,
+	ATT_V4
 };
 
+/* An argument to a macro (multiple values = `It -column'). */
 struct	mdoc_arg {
 	int	  	  arg;
+	int		  line;
+	int		  pos;
 	size_t		  sz;
 	char		**value;
 };
 
+/*
+ * Simplified grammar of syntax tree:
+ *
+ * MDOC_ROOT: root of tree
+ * MDOC_TEXT: free-form text
+ * MDOC_ELEM: elem [args] MDOC_TEXT...
+ * MDOC_BLOCK, MDOC_HEAD, MDOC_BODY, MDOC_TAIL:
+ *   MDOC_BLOCK:
+ *     MDOC_HEAD [args] (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)...
+ *     MDOC_BODY (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)...
+ *     MDOC_TAIL (optional) (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)...
+ */
+
+/* Type of a syntax node. */
 enum	mdoc_type {
 	MDOC_TEXT,
 	MDOC_ELEM,
 	MDOC_HEAD,
+	MDOC_TAIL,
 	MDOC_BODY,
-	MDOC_BLOCK
+	MDOC_BLOCK,
+	MDOC_ROOT
 };
 
+/* Manual section. */
 enum	mdoc_msec {
+	MSEC_DEFAULT = 0,
 	MSEC_1,
 	MSEC_2,
 	MSEC_3,
@@ -238,12 +270,13 @@ enum	mdoc_msec {
 	MSEC_n,
 	MSEC_unass,
 	MSEC_draft,
-	MSEC_paper,
-	MSEC_NONE
+	MSEC_paper
 };
 
+/* Section (named/unnamed) of `Ss'. */
 enum	mdoc_sec {
-	SEC_PROLOGUE,
+	SEC_PROLOGUE = 0,
+	SEC_BODY,
 	SEC_NAME,
 	SEC_SYNOPSIS,
 	SEC_DESCRIPTION,
@@ -262,7 +295,9 @@ enum	mdoc_sec {
 	SEC_CUSTOM
 };
 
+/* Volume of `Dt'. */
 enum	mdoc_vol {
+	VOL_DEFAULT = 0,
 	VOL_AMD,
 	VOL_IND,
 	VOL_KM,
@@ -271,15 +306,17 @@ enum	mdoc_vol {
 	VOL_PS1,
 	VOL_SMM,
 	VOL_URM,
-	VOL_USD,
-	VOL_DEFAULT
+	VOL_USD
 };
 
+/* Architecture of `Dt'. */
 enum	mdoc_arch {
+	ARCH_DEFAULT = 0,
 	ARCH_alpha, 
 	ARCH_amd64, 
 	ARCH_amiga, 
 	ARCH_arc, 
+	ARCH_arm, 
 	ARCH_armish, 
 	ARCH_aviion, 
 	ARCH_hp300,
@@ -300,15 +337,18 @@ enum	mdoc_arch {
 	ARCH_sparc64, 
 	ARCH_sun3, 
 	ARCH_vax, 
-	ARCH_zaurus,
-	ARCH_DEFAULT
+	ARCH_zaurus
 };
 
+/* Meta-information from prologue. */
 struct	mdoc_meta {
 	enum mdoc_msec	  msec;
 	enum mdoc_vol	  vol;
 	enum mdoc_arch	  arch;
-	struct tm	  tm;
+	time_t		  date;
+	char		 *title;
+	char		 *os;
+	char		 *name;
 };
 
 struct	mdoc_text {
@@ -316,25 +356,16 @@ struct	mdoc_text {
 };
 
 struct	mdoc_block {
-	int		  tok;
 	size_t		  argc;
 	struct mdoc_arg	 *argv;
+	struct mdoc_node *head;
+	struct mdoc_node *body;
+	struct mdoc_node *tail;
 };
 
-struct	mdoc_head {
-	size_t		  sz;
-	char		**args;
-	int		  tok;
-};
-
-struct	mdoc_body {
-	int		  tok;
-};
-
 struct	mdoc_elem {
 	size_t		  sz;
 	char		**args;
-	int		  tok;
 	size_t		  argc;
 	struct mdoc_arg	 *argv;
 };
@@ -342,23 +373,28 @@ struct	mdoc_elem {
 union	mdoc_data {
 	struct mdoc_text  text;
 	struct mdoc_elem  elem;
-	struct mdoc_body  body;
-	struct mdoc_head  head;
 	struct mdoc_block block;
 };
 
+/* Syntax node in parse tree. */
 struct	mdoc_node {
 	struct mdoc_node *parent;
 	struct mdoc_node *child;
 	struct mdoc_node *next;
+	struct mdoc_node *prev;
+	int		  line;
+	int		  pos;
+	int		  tok;
 	enum mdoc_type	  type;
 	union mdoc_data	  data;
 };
 
+/* Call-backs for parse messages. */
 struct	mdoc_cb {
-	int	(*mdoc_err)(void *, int, int, enum mdoc_err);
-	int	(*mdoc_warn)(void *, int, int, enum mdoc_warn);
-	void	(*mdoc_msg)(void *, int, const char *);
+	void	(*mdoc_msg)(void *, int, int, const char *);
+	int	(*mdoc_err)(void *, int, int, const char *);
+	int	(*mdoc_warn)(void *, int, int, 
+			enum mdoc_warn, const char *);
 };
 
 extern	const char *const *mdoc_macronames;
@@ -368,11 +404,20 @@ __BEGIN_DECLS
 
 struct	mdoc;
 
+/* Free memory allocated with mdoc_alloc. */
 void	 	  mdoc_free(struct mdoc *);
+
+/* Allocate a new parser instance. */
 struct	mdoc	 *mdoc_alloc(void *data, const struct mdoc_cb *);
-int	 	  mdoc_parseln(struct mdoc *, char *buf);
-const struct mdoc_node
-		 *mdoc_result(struct mdoc *);
+
+/* Parse a single line (boolean retval). */
+int	 	  mdoc_parseln(struct mdoc *, int, char *buf);
+
+/* Get parse result or NULL. */
+const struct mdoc_node *mdoc_result(struct mdoc *);
+
+/* Signal end of parse sequence (boolean retval). */
+int		  mdoc_endparse(struct mdoc *);
 
 __END_DECLS