Clean-ups & documentation.

6 files changed, 61 insertions, 16 deletions

diff --git a/action.c b/action.c
index 3c0981e9..19bb1387 100644
--- a/action.c
+++ b/action.c
@@ -1,4 +1,4 @@
-/* $Id: action.c,v 1.8 2009/01/16 11:50:54 kristaps Exp $ */
+/* $Id: action.c,v 1.9 2009/01/16 12:23:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -292,7 +292,7 @@ post_dd(struct mdoc *mdoc)
 
 		if ( ! xstrlcat(date, n->data.text.string, sz))
 			return(mdoc_nerr(mdoc, n, "badly-formed manual date parameter"));
-		if ( ! xstrlcat(date, " ", sz))
+		if (n->next && ! xstrlcat(date, " ", sz))
 			return(mdoc_nerr(mdoc, n, "badly-formed manual date parameter"));
 	}
 
@@ -300,6 +300,13 @@ post_dd(struct mdoc *mdoc)
 		mdoc_msg(mdoc, "parsed time: %u since epoch", 
 				mdoc->meta.date);
 		return(1);
+	} else if (n)
+		return(mdoc_err(mdoc, "badly-formed manual date"));
+
+	if ((mdoc->meta.date = mdoc_atotime(date))) {
+		mdoc_msg(mdoc, "parsed time: %u since epoch", 
+				mdoc->meta.date);
+		return(1);
 	}
 
 	return(mdoc_err(mdoc, "badly-formed manual date"));
diff --git a/argv.c b/argv.c
index 07196917..5c944a58 100644
--- a/argv.c
+++ b/argv.c
@@ -1,4 +1,4 @@
-/* $Id: argv.c,v 1.14 2009/01/16 11:50:54 kristaps Exp $ */
+/* $Id: argv.c,v 1.15 2009/01/16 12:23:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -26,6 +26,8 @@
 #include "private.h"
 
 
+/* FIXME: .It called with -column and quoted arguments. */
+
 static	int		 lookup(int, const char *);
 static	int		 parse(struct mdoc *, int, int,
 				struct mdoc_arg *, int *, char *);
diff --git a/mdoc.h b/mdoc.h
index a79834ca..cac9fee9 100644
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,4 +1,4 @@
-/* $Id: mdoc.h,v 1.22 2009/01/15 17:38:57 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.23 2009/01/16 12:23:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -19,10 +19,6 @@
 #ifndef MDOC_H
 #define MDOC_H
 
-/* FIXME: move this elsewhere (it's 9, too). */
-
-#define	MDOC_LINEARG_MAX 12
-
 /* What follows is a list of ALL possible macros. */
 
 #define	MDOC___	 	 0
@@ -204,6 +200,7 @@ enum	mdoc_warn {
 	WARN_COMPAT		/* Groff compat warn (at line/col). */
 };
 
+/* Possible values for the `At' macro. */
 enum	mdoc_att {
 	ATT_DEFAULT = 0,
 	ATT_v1,
@@ -220,6 +217,7 @@ enum	mdoc_att {
 	ATT_V4
 };
 
+/* An argument to a macro (multiple values = `It -column'). */
 struct	mdoc_arg {
 	int	  	  arg;
 	int		  line;
@@ -228,6 +226,20 @@ struct	mdoc_arg {
 	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,
@@ -238,6 +250,7 @@ enum	mdoc_type {
 	MDOC_ROOT
 };
 
+/* Manual section. */
 enum	mdoc_msec {
 	MSEC_DEFAULT = 0,
 	MSEC_1,
@@ -260,6 +273,7 @@ enum	mdoc_msec {
 	MSEC_paper
 };
 
+/* Section (named/unnamed) of `Ss'. */
 enum	mdoc_sec {
 	SEC_PROLOGUE = 0,
 	SEC_BODY,
@@ -281,6 +295,7 @@ enum	mdoc_sec {
 	SEC_CUSTOM
 };
 
+/* Volume of `Dt'. */
 enum	mdoc_vol {
 	VOL_DEFAULT = 0,
 	VOL_AMD,
@@ -294,12 +309,14 @@ enum	mdoc_vol {
 	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,
@@ -323,6 +340,7 @@ enum	mdoc_arch {
 	ARCH_zaurus
 };
 
+/* Meta-information from prologue. */
 struct	mdoc_meta {
 	enum mdoc_msec	  msec;
 	enum mdoc_vol	  vol;
@@ -359,6 +377,7 @@ union	mdoc_data {
 	struct mdoc_block block;
 };
 
+/* Syntax node in parse tree. */
 struct	mdoc_node {
 	struct mdoc_node *parent;
 	struct mdoc_node *child;
@@ -371,6 +390,7 @@ struct	mdoc_node {
 	union mdoc_data	  data;
 };
 
+/* Call-backs for parse messages. */
 struct	mdoc_cb {
 	void	(*mdoc_msg)(void *, int, int, const char *);
 	int	(*mdoc_err)(void *, int, int, const char *);
@@ -385,13 +405,22 @@ __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 *);
+
+/* Parse a single line (boolean retval). */
 int	 	  mdoc_parseln(struct mdoc *, int, char *buf);
-const struct mdoc_node
-		 *mdoc_result(struct mdoc *);
+
+/* 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 *);
 
+/* Node type to static string. */
 char		 *mdoc_type2a(enum mdoc_type);
 
 __END_DECLS
diff --git a/private.h b/private.h
index 0895f30b..a46a5612 100644
--- a/private.h
+++ b/private.h
@@ -1,4 +1,4 @@
-/* $Id: private.h,v 1.64 2009/01/15 17:38:58 kristaps Exp $ */
+/* $Id: private.h,v 1.65 2009/01/16 12:23:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -41,6 +41,10 @@ struct	mdoc {
 };
 
 
+/* FIXME: it's 9 (this isn't used properly). */
+
+#define	MDOC_LINEARG_MAX 12
+
 #define	MACRO_PROT_ARGS	struct mdoc *mdoc, int tok, int line, \
 			int ppos, int *pos, char *buf
 
diff --git a/strings.c b/strings.c
index 45702638..33cc7b04 100644
--- a/strings.c
+++ b/strings.c
@@ -1,4 +1,4 @@
-/* $Id: strings.c,v 1.7 2009/01/16 11:50:54 kristaps Exp $ */
+/* $Id: strings.c,v 1.8 2009/01/16 12:23:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -135,9 +135,9 @@ mdoc_atotime(const char *p)
 
 	(void)memset(&tm, 0, sizeof(struct tm));
 
-	if (strptime(p, "%b %d %Y", &tm))
+	if (0 == strptime(p, "%b %d %Y", &tm))
 		return(mktime(&tm));
-	if (strptime(p, "%b %d, %Y", &tm))
+	if (0 == strptime(p, "%b %d, %Y", &tm))
 		return(mktime(&tm));
 
 	return(0);
@@ -228,6 +228,8 @@ mdoc_atoarch(const char *p)
 		return(ARCH_amiga);
 	else if (0 == strcmp(p, "arc"))
 		return(ARCH_arc);
+	else if (0 == strcmp(p, "arm"))
+		return(ARCH_arm);
 	else if (0 == strcmp(p, "armish"))
 		return(ARCH_armish);
 	else if (0 == strcmp(p, "aviion"))
diff --git a/validate.c b/validate.c
index f105064a..6a22f634 100644
--- a/validate.c
+++ b/validate.c
@@ -1,4 +1,4 @@
-/* $Id: validate.c,v 1.31 2009/01/16 11:50:54 kristaps Exp $ */
+/* $Id: validate.c,v 1.32 2009/01/16 12:23:25 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -306,7 +306,8 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node)
 	if (MDOC_BLOCK != node->type)
 		return(1);
 
-	for (n = mdoc->last; n; n = n->parent) 
+	assert(mdoc->last);
+	for (n = mdoc->last->parent; n; n = n->parent) 
 		if (MDOC_BLOCK == n->type)
 			if (MDOC_Bd == n->tok)
 				break;