summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-08-20 13:22:48 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-08-20 13:22:48 +0000
commite1705017f36f9b6ace72ca94ca546e984e919b18 (patch)
tree4c61c2efc3ba7879b3f98840d3df2236a615a6bd
parentc3829fc88899838b68249bab2a47f14c64d611f4 (diff)
downloadmandoc-e1705017f36f9b6ace72ca94ca546e984e919b18.tar.gz
mandoc-e1705017f36f9b6ace72ca94ca546e984e919b18.tar.zst
mandoc-e1705017f36f9b6ace72ca94ca546e984e919b18.zip
Updated manual structure in mdoc.7.
Synchronised mdoc.template and mdoc.7 manual structure. `Rv' and `Ex' now accept multiple arguments (-std made standalone, terms as children). `Rv' and `Ex' format correctly in -Tascii (plurals, commas, etc.).
-rw-r--r--mdoc.746
-rw-r--r--mdoc.h6
-rw-r--r--mdoc.template24
-rw-r--r--mdoc_action.c361
-rw-r--r--mdoc_argv.c4
-rw-r--r--mdoc_term.c72
-rw-r--r--mdoc_validate.c19
7 files changed, 282 insertions, 250 deletions
diff --git a/mdoc.7 b/mdoc.7
index 4fb87614..ea263c2f 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.57 2009/08/20 12:08:40 kristaps Exp $
+.\" $Id: mdoc.7,v 1.58 2009/08/20 13:22:48 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -67,7 +67,8 @@ Text following a
whether in a macro or free-form text line, is ignored to the end of
line. A macro line with only a control character and comment escape,
.Sq \&.\e" ,
-is also ignored.
+is also ignored. Macro lines with only a control charater and optionally
+whitespace are stripped from input.
.
.
.Ss Reserved Characters
@@ -224,9 +225,42 @@ followed by
\&.Dd $\&Mdocdate$
\&.Dt mdoc 7
\&.Os
+\&.
\&.Sh NAME
-\&.Nm mdoc
-\&.Nd mdoc language reference
+\&.Nm foo
+\&.Nd a description goes here
+\&.\e\*q The next is for sections 2 & 3 only.
+\&.\e\*q .Sh LIBRARY
+\&.
+\&.Sh SYNOPSIS
+\&.Nm foo
+\&.Op Fl options
+\&.Ar
+\&.
+\&.Sh DESCRIPTION
+The
+\&.Nm
+utility processes files ...
+\&.\e\*q The next is for sections 1 & 8 only.
+\&.\e\*q .Sh EXIT STATUS
+\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q .Sh RETURN VALUES
+\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q .Sh ENVIRONMENT
+\&.\e\*q .Sh FILES
+\&.\e\*q .Sh EXAMPLES
+\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
+\&.\e\*q .Sh DIAGNOSTICS
+\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q .Sh ERRORS
+\&.\e\*q .Sh SEE ALSO
+\&.\e\*q .Xr foobar 1
+\&.\e\*q .Sh STANDARDS
+\&.\e\*q .Sh HISTORY
+\&.\e\*q .Sh AUTHORS
+\&.\e\*q .Sh CAVEATS
+\&.\e\*q .Sh BUGS
+\&.\e\*q .Sh SECURITY CONSIDERATIONS
.Ed
.
.Pp
@@ -453,7 +487,7 @@ then the macro accepts an arbitrary number of arguments.
.It \&Er Ta Yes Ta Yes Ta >0
.It \&Es Ta \&No Ta \&No Ta 0
.It \&Ev Ta Yes Ta Yes Ta n
-.It \&Ex Ta \&No Ta \&No Ta 0
+.It \&Ex Ta \&No Ta \&No Ta n
.It \&Fa Ta Yes Ta Yes Ta n
.It \&Fd Ta \&No Ta \&No Ta >0
.It \&Fl Ta Yes Ta Yes Ta n
@@ -480,7 +514,7 @@ then the macro accepts an arbitrary number of arguments.
.It \&Pa Ta Yes Ta Yes Ta n
.It \&Pf Ta \&No Ta Yes Ta 1
.It \&Pp Ta \&No Ta \&No Ta 0
-.It \&Rv Ta \&No Ta \&No Ta 0
+.It \&Rv Ta \&No Ta \&No Ta n
.It \&Sm Ta \&No Ta \&No Ta 1
.It \&St Ta \&No Ta Yes Ta 1
.It \&Sx Ta Yes Ta Yes Ta >0
diff --git a/mdoc.h b/mdoc.h
index 292f3b20..334faee4 100644
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,4 +1,4 @@
-/* $Id: mdoc.h,v 1.67 2009/07/24 12:48:18 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.68 2009/08/20 13:22:48 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
@@ -200,8 +200,9 @@ enum mdoc_sec {
SEC_SYNOPSIS,
SEC_DESCRIPTION,
SEC_IMPLEMENTATION,
+ /* FIXME: EXIT STATUS */
SEC_RETURN_VALUES,
- SEC_ENVIRONMENT,
+ SEC_ENVIRONMENT,
SEC_FILES,
SEC_EXAMPLES,
SEC_DIAGNOSTICS,
@@ -213,6 +214,7 @@ enum mdoc_sec {
SEC_AUTHORS,
SEC_CAVEATS,
SEC_BUGS,
+ /* FIXME: SECURITY CONSIDERATIONS */
SEC_CUSTOM /* User-defined. */
};
diff --git a/mdoc.template b/mdoc.template
index 6d2beb0d..9dcf5893 100644
--- a/mdoc.template
+++ b/mdoc.template
@@ -2,36 +2,36 @@
.\"
.\" Copyright notice goes here.
.\"
-.\" The uncommented requests are required for all man pages.
+.\" The uncommented requests are required for all manual pages.
.\" The commented requests should be uncommented and used where appropriate.
.\"
.\" See mdoc(7) for further reference.
.\"
.Dd $\&Mdocdate$
-.Dt <document_title> <section>
+.Dt title section
.Os
+.
.Sh NAME
-.Nm <name>
-.Nd <description>
-.\" The next request should be used for sections 2 and 3 only.
+.Nm name
+.Nd short description
+.\" The next is for sections 2 & 3 only.
.\" .Sh LIBRARY
.Sh SYNOPSIS
.Sh DESCRIPTION
-.\" This next request is for sections 1 and 8 exit statuses only.
+.\" The next is for sections 1 & 8 only.
.\" .Sh EXIT STATUS
-.\" This next request is for sections 2 and 3 function return values only.
+.\" The next is for sections 2, 3, & 9 only.
.\" .Sh RETURN VALUES
-.\" This next request is for sections 1, 6, 7 & 8 only.
+.\" The next is for sections 1, 6, 7 & 8 only.
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
-.\" This next request is for sections 1, 6, 7 & 8 only
+.\" The next is for sections 1, 4, 6, 7, & 8 only
.\" .Sh DIAGNOSTICS
-.\" The next request is for sections 2 and 3 error and signal handling only.
+.\" The next is for sections 2, 3, & 9 only.
.\" .Sh ERRORS
.\" .Sh SEE ALSO
-.\" Cross-references should be ordered by section (low to high), then in
-.\" alphabetical order.
+.\" .Xr foobar 1
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
diff --git a/mdoc_action.c b/mdoc_action.c
index 87882138..ec1161e9 100644
--- a/mdoc_action.c
+++ b/mdoc_action.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc_action.c,v 1.34 2009/07/26 10:29:39 kristaps Exp $ */
+/* $Id: mdoc_action.c,v 1.35 2009/08/20 13:22:48 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
@@ -24,8 +24,8 @@
#include "libmdoc.h"
+#define POST_ARGS struct mdoc *m, struct mdoc_node *n
#define PRE_ARGS struct mdoc *m, const struct mdoc_node *n
-#define POST_ARGS struct mdoc *m
struct actions {
int (*pre)(PRE_ARGS);
@@ -71,7 +71,7 @@ const struct actions mdoc_actions[MDOC_MAX] = {
{ NULL, NULL }, /* Ad */
{ NULL, NULL }, /* An */
{ NULL, post_ar }, /* Ar */
- { NULL, NULL }, /* Cd */ /* FIXME: tabs are accepted! */
+ { NULL, NULL }, /* Cd */
{ NULL, NULL }, /* Cm */
{ NULL, NULL }, /* Dv */
{ NULL, NULL }, /* Er */
@@ -222,7 +222,7 @@ mdoc_action_post(struct mdoc *m)
if (NULL == mdoc_actions[m->last->tok].post)
return(1);
- return((*mdoc_actions[m->last->tok].post)(m));
+ return((*mdoc_actions[m->last->tok].post)(m, m->last));
}
@@ -248,27 +248,17 @@ concat(struct mdoc *m, const struct mdoc_node *n,
static int
post_std(POST_ARGS)
{
+ struct mdoc_node *nn;
- /*
- * If '-std' is invoked without an argument, fill it in with our
- * name (if it's been set).
- */
-
- if (NULL == m->last->args)
+ if (n->child)
return(1);
- if (m->last->args->argv[0].sz)
- return(1);
-
+
+ nn = n;
+ m->next = MDOC_NEXT_CHILD;
assert(m->meta.name);
-
- m->last->args->argv[0].value = calloc(1, sizeof(char *));
- if (NULL == m->last->args->argv[0].value)
- return(mdoc_nerr(m, m->last, EMALLOC));
-
- m->last->args->argv[0].sz = 1;
- m->last->args->argv[0].value[0] = strdup(m->meta.name);
- if (NULL == m->last->args->argv[0].value[0])
- return(mdoc_nerr(m, m->last, EMALLOC));
+ if ( ! mdoc_word_alloc(m, n->line, n->pos, m->meta.name))
+ return(0);
+ m->last = nn;
return(1);
}
@@ -283,11 +273,10 @@ post_nm(POST_ARGS)
return(1);
buf[0] = 0;
- if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ if ( ! concat(m, n->child, buf, sizeof(buf)))
return(0);
-
if (NULL == (m->meta.name = strdup(buf)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
return(1);
}
@@ -300,25 +289,26 @@ post_lb(POST_ARGS)
char *buf;
size_t sz;
- assert(MDOC_TEXT == m->last->child->type);
- p = mdoc_a2lib(m->last->child->string);
+ assert(MDOC_TEXT == n->child->type);
+ p = mdoc_a2lib(n->child->string);
if (NULL == p) {
- sz = strlen(m->last->child->string) +
+ sz = strlen(n->child->string) +
2 + strlen("\\(lqlibrary\\(rq");
buf = malloc(sz);
if (NULL == buf)
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
(void)snprintf(buf, sz, "library \\(lq%s\\(rq",
- m->last->child->string);
- free(m->last->child->string);
- m->last->child->string = buf;
+ n->child->string);
+ free(n->child->string);
+ n->child->string = buf;
return(1);
}
- free(m->last->child->string);
- m->last->child->string = strdup(p);
- if (NULL == m->last->child->string)
- return(mdoc_nerr(m, m->last, EMALLOC));
+ free(n->child->string);
+ n->child->string = strdup(p);
+ if (NULL == n->child->string)
+ return(mdoc_nerr(m, n, EMALLOC));
+
return(1);
}
@@ -328,13 +318,14 @@ post_st(POST_ARGS)
{
const char *p;
- assert(MDOC_TEXT == m->last->child->type);
- p = mdoc_a2st(m->last->child->string);
+ assert(MDOC_TEXT == n->child->type);
+ p = mdoc_a2st(n->child->string);
assert(p);
- free(m->last->child->string);
- m->last->child->string = strdup(p);
- if (NULL == m->last->child->string)
- return(mdoc_nerr(m, m->last, EMALLOC));
+ free(n->child->string);
+ n->child->string = strdup(p);
+ if (NULL == n->child->string)
+ return(mdoc_nerr(m, n, EMALLOC));
+
return(1);
}
@@ -342,28 +333,27 @@ post_st(POST_ARGS)
static int
post_at(POST_ARGS)
{
- struct mdoc_node *n;
- const char *p;
+ struct mdoc_node *nn;
+ const char *p;
- if (m->last->child) {
- assert(MDOC_TEXT == m->last->child->type);
- p = mdoc_a2att(m->last->child->string);
+ if (n->child) {
+ assert(MDOC_TEXT == n->child->type);
+ p = mdoc_a2att(n->child->string);
assert(p);
- free(m->last->child->string);
- m->last->child->string = strdup(p);
- if (NULL == m->last->child->string)
- return(mdoc_nerr(m, m->last, EMALLOC));
+ free(n->child->string);
+ n->child->string = strdup(p);
+ if (NULL == n->child->string)
+ return(mdoc_nerr(m, n, EMALLOC));
return(1);
}
- n = m->last;
+ nn = n;
m->next = MDOC_NEXT_CHILD;
- if ( ! mdoc_word_alloc(m, n->line, n->pos, "AT&T UNIX"))
+ if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
return(0);
+ m->last = nn;
- m->last = n;
- m->next = MDOC_NEXT_SIBLING;
return(1);
}
@@ -380,11 +370,11 @@ post_sh(POST_ARGS)
* check ordering.
*/
- if (MDOC_HEAD != m->last->type)
+ if (MDOC_HEAD != n->type)
return(1);
buf[0] = 0;
- if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ if ( ! concat(m, n->child, buf, sizeof(buf)))
return(0);
if (SEC_CUSTOM != (sec = mdoc_atosec(buf)))
m->lastnamed = sec;
@@ -401,7 +391,7 @@ post_sh(POST_ARGS)
case (9):
break;
default:
- return(mdoc_nwarn(m, m->last, EBADSEC));
+ return(mdoc_nwarn(m, n, EBADSEC));
}
break;
default:
@@ -414,7 +404,7 @@ post_sh(POST_ARGS)
static int
post_dt(POST_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *nn;
const char *cp;
char *ep;
long lval;
@@ -433,25 +423,25 @@ post_dt(POST_ARGS)
* --> title = unknown, volume = local, msec = 0, arch = NULL
*/
- if (NULL == (n = m->last->child)) {
+ if (NULL == (nn = n->child)) {
if (NULL == (m->meta.title = strdup("unknown")))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
if (NULL == (m->meta.vol = strdup("local")))
- return(mdoc_nerr(m, m->last, EMALLOC));
- return(post_prol(m));
+ return(mdoc_nerr(m, n, EMALLOC));
+ return(post_prol(m, n));
}
/* Handles: `.Dt TITLE'
* --> title = TITLE, volume = local, msec = 0, arch = NULL
*/
- if (NULL == (m->meta.title = strdup(n->string)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ if (NULL == (m->meta.title = strdup(nn->string)))
+ return(mdoc_nerr(m, n, EMALLOC));
- if (NULL == (n = n->next)) {
+ if (NULL == (nn = nn->next)) {
if (NULL == (m->meta.vol = strdup("local")))
- return(mdoc_nerr(m, m->last, EMALLOC));
- return(post_prol(m));
+ return(mdoc_nerr(m, n, EMALLOC));
+ return(post_prol(m, n));
}
/* Handles: `.Dt TITLE SEC'
@@ -461,19 +451,19 @@ post_dt(POST_ARGS)
* arch = NULL
*/
- cp = mdoc_a2msec(n->string);
+ cp = mdoc_a2msec(nn->string);
if (cp) {
if (NULL == (m->meta.vol = strdup(cp)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
errno = 0;
- lval = strtol(n->string, &ep, 10);
- if (n->string[0] != '\0' && *ep == '\0')
+ lval = strtol(nn->string, &ep, 10);
+ if (nn->string[0] != '\0' && *ep == '\0')
m->meta.msec = (int)lval;
- } else if (NULL == (m->meta.vol = strdup(n->string)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ } else if (NULL == (m->meta.vol = strdup(nn->string)))
+ return(mdoc_nerr(m, n, EMALLOC));
- if (NULL == (n = n->next))
- return(post_prol(m));
+ if (NULL == (nn = nn->next))
+ return(post_prol(m, n));
/* Handles: `.Dt TITLE SEC VOL'
* --> title = TITLE, volume = VOL is vol ?
@@ -482,24 +472,24 @@ post_dt(POST_ARGS)
* VOL
*/
- cp = mdoc_a2vol(n->string);
+ cp = mdoc_a2vol(nn->string);
if (cp) {
free(m->meta.vol);
if (NULL == (m->meta.vol = strdup(cp)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
} else {
- cp = mdoc_a2arch(n->string);
+ cp = mdoc_a2arch(nn->string);
if (NULL == cp) {
free(m->meta.vol);
- if (NULL == (m->meta.vol = strdup(n->string)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ if (NULL == (m->meta.vol = strdup(nn->string)))
+ return(mdoc_nerr(m, n, EMALLOC));
} else if (NULL == (m->meta.arch = strdup(cp)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
}
/* Ignore any subsequent parameters... */
- return(post_prol(m));
+ return(post_prol(m, n));
}
@@ -513,24 +503,24 @@ post_os(POST_ARGS)
free(m->meta.os);
buf[0] = 0;
- if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ if ( ! concat(m, n->child, buf, sizeof(buf)))
return(0);
if (0 == buf[0]) {
if (-1 == uname(&utsname))
- return(mdoc_nerr(m, m->last, EUTSNAME));
+ return(mdoc_nerr(m, n, EUTSNAME));
if (strlcat(buf, utsname.sysname, 64) >= 64)
- return(mdoc_nerr(m, m->last, ETOOLONG));
+ return(mdoc_nerr(m, n, ETOOLONG));
if (strlcat(buf, " ", 64) >= 64)
- return(mdoc_nerr(m, m->last, ETOOLONG));
+ return(mdoc_nerr(m, n, ETOOLONG));
if (strlcat(buf, utsname.release, 64) >= 64)
- return(mdoc_nerr(m, m->last, ETOOLONG));
+ return(mdoc_nerr(m, n, ETOOLONG));
}
if (NULL == (m->meta.os = strdup(buf)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ return(mdoc_nerr(m, n, EMALLOC));
- return(post_prol(m));
+ return(post_prol(m, n));
}
@@ -539,9 +529,9 @@ post_os(POST_ARGS)
* Uses the first head macro.
*/
static int
-post_bl_tagwidth(struct mdoc *m)
+post_bl_tagwidth(POST_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *nn;
int sz;
char buf[32];
@@ -550,75 +540,75 @@ post_bl_tagwidth(struct mdoc *m)
* width if a macro.
*/
- n = m->last->body->child;
- if (n) {
- assert(MDOC_BLOCK == n->type);
- assert(MDOC_It == n->tok);
- n = n->head->child;
+ nn = n->body->child;
+ if (nn) {
+ assert(MDOC_BLOCK == nn->type);
+ assert(MDOC_It == nn->tok);
+ nn = nn->head->child;
}
sz = 10; /* Default size. */
- if (n) {
- if (MDOC_TEXT != n->type) {
- if (0 == (sz = (int)mdoc_macro2len(n->tok)))
- if ( ! mdoc_nwarn(m, m->last, ENOWIDTH))
+ if (nn) {
+ if (MDOC_TEXT != nn->type) {
+ if (0 == (sz = (int)mdoc_macro2len(nn->tok)))
+ if ( ! mdoc_nwarn(m, n, ENOWIDTH))
return(0);
} else
- sz = (int)strlen(n->string) + 1;
+ sz = (int)strlen(nn->string) + 1;
}
if (-1 == snprintf(buf, sizeof(buf), "%dn", sz))
- return(mdoc_nerr(m, m->last, ENUMFMT));
+ return(mdoc_nerr(m, n, ENUMFMT));
/*
* We have to dynamically add this to the macro's argument list.
* We're guaranteed that a MDOC_Width doesn't already exist.
*/
- n = m->last;
- assert(n->args);
- sz = (int)(n->args->argc)++;
+ nn = n;
+ assert(nn->args);
+ sz = (int)(nn->args->argc)++;
- n->args->argv = realloc(n->args->argv,
- n->args->argc * sizeof(struct mdoc_argv));
+ nn->args->argv = realloc(nn->args->argv,
+ nn->args->argc * sizeof(struct mdoc_argv));
- if (NULL == n->args->argv)
- return(mdoc_nerr(m, m->last, EMALLOC));
+ if (NULL == nn->args->argv)
+ return(mdoc_nerr(m, n, EMALLOC));
- n->args->argv[sz].arg = MDOC_Width;
- n->args->argv[sz].line = m->last->line;
- n->args->argv[sz].pos = m->last->pos;
- n->args->argv[sz].sz = 1;
- n->args->argv[sz].value = calloc(1, sizeof(char *));
+ nn->args->argv[sz].arg = MDOC_Width;
+ nn->args->argv[sz].line = n->line;
+ nn->args->argv[sz].pos = n->pos;
+ nn->args->argv[sz].sz = 1;
+ nn->args->argv[sz].value = calloc(1, sizeof(char *));
- if (NULL == n->args->argv[sz].value)
- return(mdoc_nerr(m, m->last, EMALLOC));
- if (NULL == (n->args->argv[sz].value[0] = strdup(buf)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ if (NULL == nn->args->argv[sz].value)
+ return(mdoc_nerr(m, n, EMALLOC));
+ if (NULL == (nn->args->argv[sz].value[0] = strdup(buf)))
+ return(mdoc_nerr(m, n, EMALLOC));
return(1);
}
static int
-post_bl_width(struct mdoc *m)
+post_bl_width(POST_ARGS)
{
size_t width;
int i, tok;
char buf[32];
char *p;
- if (NULL == m->last->args)
+ if (NULL == n->args)
return(1);
- for (i = 0; i < (int)m->last->args->argc; i++)
- if (MDOC_Width == m->last->args->argv[i].arg)
+ for (i = 0; i < (int)n->args->argc; i++)
+ if (MDOC_Width == n->args->argv[i].arg)
break;
- if (i == (int)m->last->args->argc)
+ if (i == (int)n->args->argc)
return(1);
- p = m->last->args->argv[i].value[0];
+ p = n->args->argv[i].value[0];
/*
* If the value to -width is a macro, then we re-write it to be
@@ -630,44 +620,45 @@ post_bl_width(struct mdoc *m)
else if (MDOC_MAX == (tok = mdoc_hash_find(m->htab, p)))
return(1);
else if (0 == (width = mdoc_macro2len(tok)))
- return(mdoc_nwarn(m, m->last, ENOWIDTH));
+ return(mdoc_nwarn(m, n, ENOWIDTH));
/* The value already exists: free and reallocate it. */
if (-1 == snprintf(buf, sizeof(buf), "%zun", width))
- return(mdoc_nerr(m, m->last, ENUMFMT));
+ return(mdoc_nerr(m, n, ENUMFMT));
- free(m->last->args->argv[i].value[0]);
- m->last->args->argv[i].value[0] = strdup(buf);
- if (NULL == m->last->args->argv[i].value[0])
- return(mdoc_nerr(m, m->last, EMALLOC));
+ free(n->args->argv[i].value[0]);
+ n->args->argv[i].value[0] = strdup(buf);
+ if (NULL == n->args->argv[i].value[0])
+ return(mdoc_nerr(m, n, EMALLOC));
return(1);
}
+/* ARGSUSED */
static int
post_bl_head(POST_ARGS)
{
int i, c;
- struct mdoc_node *n, *nn, *nnp;
+ struct mdoc_node *np, *nn, *nnp;
- if (NULL == m->last->child)
+ if (NULL == n->child)
return(1);
- n = m->last->parent;
- assert(n->args);
+ np = n->parent;
+ assert(np->args);
- for (c = 0; c < (int)n->args->argc; c++)
- if (MDOC_Column == n->args->argv[c].arg)
+ for (c = 0; c < (int)np->args->argc; c++)
+ if (MDOC_Column == np->args->argv[c].arg)
break;
/* Only process -column. */
- if (c == (int)n->args->argc)
+ if (c == (int)np->args->argc)
return(1);
- assert(0 == n->args->argv[c].sz);
+ assert(0 == np->args->argv[c].sz);
/*
* Accomodate for new-style groff column syntax. Shuffle the
@@ -675,20 +666,20 @@ post_bl_head(POST_ARGS)
* column field. Then, delete the head children.
*/
- n->args->argv[c].sz = (size_t)m->last->nchild;
- n->args->argv[c].value = malloc
- ((size_t)m->last->nchild * sizeof(char *));
+ np->args->argv[c].sz = (size_t)n->nchild;
+ np->args->argv[c].value = malloc
+ ((size_t)n->nchild * sizeof(char *));
- for (i = 0, nn = m->last->child; nn; i++) {
- n->args->argv[c].value[i] = nn->string;
+ for (i = 0, nn = n->child; nn; i++) {
+ np->args->argv[c].value[i] = nn->string;
nn->string = NULL;
nnp = nn;
nn = nn->next;
mdoc_node_free(nnp);
}
- m->last->nchild = 0;
- m->last->child = NULL;
+ n->nchild = 0;
+ n->child = NULL;
return(1);
}
@@ -699,9 +690,9 @@ post_bl(POST_ARGS)
{
int i, r, len;
- if (MDOC_HEAD == m->last->type)
- return(post_bl_head(m));
- if (MDOC_BLOCK != m->last->type)
+ if (MDOC_HEAD == n->type)
+ return(post_bl_head(m, n));
+ if (MDOC_BLOCK != n->type)
return(1);
/*
@@ -712,20 +703,20 @@ post_bl(POST_ARGS)
* rewritten into real lengths).
*/
- len = (int)(m->last->args ? m->last->args->argc : 0);
+ len = (int)(n->args ? n->args->argc : 0);
for (r = i = 0; i < len; i++) {
- if (MDOC_Tag == m->last->args->argv[i].arg)
+ if (MDOC_Tag == n->args->argv[i].arg)
r |= 1 << 0;
- if (MDOC_Width == m->last->args->argv[i].arg)
+ if (MDOC_Width == n->args->argv[i].arg)
r |= 1 << 1;
}
if (r & (1 << 0) && ! (r & (1 << 1))) {
- if ( ! post_bl_tagwidth(m))
+ if ( ! post_bl_tagwidth(m, n))
return(0);
} else if (r & (1 << 1))
- if ( ! post_bl_width(m))
+ if ( ! post_bl_width(m, n))
return(0);
return(1);
@@ -735,20 +726,19 @@ post_bl(POST_ARGS)
static int
post_tilde(POST_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *np;
- if (m->last->child)
+ if (n->child)
return(1);
- n = m->last;
+ np = n;
m->next = MDOC_NEXT_CHILD;
/* XXX: not documented for `Lk'. */
- if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "~"))
+ if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
return(0);
+ m->last = np;
- m->last = n;
- m->next = MDOC_NEXT_SIBLING;
return(1);
}
@@ -756,21 +746,19 @@ post_tilde(POST_ARGS)
static int
post_ar(POST_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *np;
- if (m->last->child)
+ if (n->child)
return(1);
- n = m->last;
+ np = n;
m->next = MDOC_NEXT_CHILD;
- if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "file"))
+ if ( ! mdoc_word_alloc(m, n->line, n->pos, "file"))
return(0);
- m->next = MDOC_NEXT_SIBLING;
- if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "..."))
+ if ( ! mdoc_word_alloc(m, n->line, n->pos, "..."))
return(0);
+ m->last = np;
- m->last = n;
- m->next = MDOC_NEXT_SIBLING;
return(1);
}
@@ -781,49 +769,47 @@ post_dd(POST_ARGS)
char buf[64];
buf[0] = 0;
- if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ if ( ! concat(m, n->child, buf, sizeof(buf)))
return(0);
if (0 == (m->meta.date = mdoc_atotime(buf))) {
- if ( ! mdoc_nwarn(m, m->last, EBADDATE))
+ if ( ! mdoc_nwarn(m, n, EBADDATE))
return(0);
m->meta.date = time(NULL);
}
- return(post_prol(m));
+ return(post_prol(m, n));
}
static int
post_prol(POST_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *np;
- /*
- * The end document shouldn't have the prologue macros as part
- * of the syntax tree (they encompass only meta-data).
- */
+ /* Remove prologue macros from AST. */
- if (m->last->parent->child == m->last)
- m->last->parent->child = m->last->prev;
- if (m->last->prev)
- m->last->prev->next = NULL;
+ if (n->parent->child == n)
+ n->parent->child = n->prev;
+ if (n->prev)
+ n->prev->next = NULL;
- n = m->last;
- assert(NULL == m->last->next);
+ np = n;
+ assert(NULL == n->next);
- if (m->last->prev) {
- m->last = m->last->prev;
+ if (n->prev) {
+ m->last = n->prev;
m->next = MDOC_NEXT_SIBLING;
} else {
- m->last = m->last->parent;
+ m->last = n->parent;
m->next = MDOC_NEXT_CHILD;
}
- mdoc_node_freelist(n);
+ mdoc_node_freelist(np);
if (m->meta.title && m->meta.date && m->meta.os)
m->flags |= MDOC_PBODY;
+
return(1);
}
@@ -834,7 +820,6 @@ pre_dl(PRE_ARGS)
if (MDOC_BODY == n->type)
m->flags |= MDOC_LITERAL;
-
return(1);
}
@@ -871,7 +856,7 @@ static int
post_display(POST_ARGS)
{
- if (MDOC_BODY == m->last->type)
+ if (MDOC_BODY == n->type)
m->flags &= ~MDOC_LITERAL;
return(1);
}
diff --git a/mdoc_argv.c b/mdoc_argv.c
index 6e2c48b3..7d36784d 100644
--- a/mdoc_argv.c
+++ b/mdoc_argv.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc_argv.c,v 1.24 2009/08/20 09:07:24 kristaps Exp $ */
+/* $Id: mdoc_argv.c,v 1.25 2009/08/20 13:22:48 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
@@ -74,7 +74,7 @@ static int mdoc_argvflags[MDOC_ARG_MAX] = {
ARGV_MULTI, /* MDOC_Column */
ARGV_SINGLE, /* MDOC_Width */
ARGV_NONE, /* MDOC_Compact */
- ARGV_OPT_SINGLE, /* MDOC_Std */
+ ARGV_NONE, /* MDOC_Std */
ARGV_NONE, /* MDOC_Filled */
ARGV_NONE, /* MDOC_Words */
ARGV_NONE, /* MDOC_Emphasis */
diff --git a/mdoc_term.c b/mdoc_term.c
index e9fd55ff..2bd7cd2f 100644
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc_term.c,v 1.67 2009/08/19 14:45:56 kristaps Exp $ */
+/* $Id: mdoc_term.c,v 1.68 2009/08/20 13:22:48 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
@@ -1237,23 +1237,33 @@ termp_rs_pre(DECL_ARGS)
static int
termp_rv_pre(DECL_ARGS)
{
- int i;
-
- i = arg_getattr(MDOC_Std, node);
- assert(-1 != i);
- assert(node->args->argv[i].sz);
+ const struct mdoc_node *nn;
term_newln(p);
term_word(p, "The");
- p->flags |= ttypes[TTYPE_FUNC_NAME];
- term_word(p, *node->args->argv[i].value);
- p->flags &= ~ttypes[TTYPE_FUNC_NAME];
- p->flags |= TERMP_NOSPACE;
+ nn = node->child;
+ assert(nn);
+ for ( ; nn; nn = nn->next) {
+ p->flags |= ttypes[TTYPE_FUNC_NAME];
+ term_word(p, nn->string);
+ p->flags &= ~ttypes[TTYPE_FUNC_NAME];
+ p->flags |= TERMP_NOSPACE;
+ if (nn->next && NULL == nn->next->next)
+ term_word(p, "(), and");
+ else if (nn->next)
+ term_word(p, "(),");
+ else
+ term_word(p, "()");
+ }
+
+ if (node->child->next)
+ term_word(p, "functions return");
+ else
+ term_word(p, "function returns");
- term_word(p, "() function returns the value 0 if successful;");
- term_word(p, "otherwise the value -1 is returned and the");
- term_word(p, "global variable");
+ term_word(p, "the value 0 if successful; otherwise the value "
+ "-1 is returned and the global variable");
p->flags |= ttypes[TTYPE_VAR_DECL];
term_word(p, "errno");
@@ -1261,7 +1271,7 @@ termp_rv_pre(DECL_ARGS)
term_word(p, "is set to indicate the error.");
- return(1);
+ return(0);
}
@@ -1269,19 +1279,33 @@ termp_rv_pre(DECL_ARGS)
static int
termp_ex_pre(DECL_ARGS)
{
- int i;
-
- i = arg_getattr(MDOC_Std, node);
- assert(-1 != i);
- assert(node->args->argv[i].sz);
+ const struct mdoc_node *nn;
term_word(p, "The");
- p->flags |= ttypes[TTYPE_PROG];
- term_word(p, *node->args->argv[i].value);
- p->flags &= ~ttypes[TTYPE_PROG];
- term_word(p, "utility exits 0 on success, and >0 if an error occurs.");
- return(1);
+ nn = node->child;
+ assert(nn);
+ for ( ; nn; nn = nn->next) {
+ p->flags |= ttypes[TTYPE_PROG];
+ term_word(p, nn->string);
+ p->flags &= ~ttypes[TTYPE_PROG];
+ p->flags |= TERMP_NOSPACE;
+ if (nn->next && NULL == nn->next->next)
+ term_word(p, ", and");
+ else if (nn->next)
+ term_word(p, ",");
+ else
+ p->flags &= ~TERMP_NOSPACE;
+ }
+
+ if (node->child->next)
+ term_word(p, "utilities exit");
+ else
+ term_word(p, "utility exits");
+
+ term_word(p, "0 on success, and >0 if an error occurs.");
+
+ return(0);
}
diff --git a/mdoc_validate.c b/mdoc_validate.c
index 1b04ccc7..60e60ce8 100644
--- a/mdoc_validate.c
+++ b/mdoc_validate.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc_validate.c,v 1.41 2009/07/25 16:03:03 kristaps Exp $ */
+/* $Id: mdoc_validate.c,v 1.42 2009/08/20 13:22:48 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
@@ -81,7 +81,6 @@ static int hwarn_eq1(POST_ARGS);
static int hwarn_le1(POST_ARGS);
static int post_an(POST_ARGS);
-static int post_args(POST_ARGS);
static int post_at(POST_ARGS);
static int post_bf(POST_ARGS);
static int post_bl(POST_ARGS);
@@ -118,7 +117,6 @@ static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
-static v_post posts_ex[] = { eerr_eq0, post_args, NULL };
static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
static v_post posts_in[] = { eerr_eq1, NULL };
static v_post posts_it[] = { post_it, NULL };
@@ -127,7 +125,6 @@ static v_post posts_nd[] = { berr_ge1, NULL };
static v_post posts_nm[] = { post_nm, NULL };
static v_post posts_notext[] = { eerr_eq0, NULL };
static v_post posts_pf[] = { eerr_eq1, NULL };
-static v_post posts_rv[] = { eerr_eq0, post_args, NULL };
static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
static v_post posts_sp[] = { post_sp, NULL };
static v_post posts_ss[] = { herr_ge1, NULL };
@@ -176,7 +173,7 @@ const struct valids mdoc_valids[MDOC_MAX] = {
{ NULL, NULL }, /* Dv */
{ pres_er, posts_text }, /* Er */
{ NULL, NULL }, /* Ev */
- { pres_ex, posts_ex }, /* Ex */
+ { pres_ex, NULL }, /* Ex */
{ NULL, NULL }, /* Fa */
{ pres_fd, posts_wtext }, /* Fd */
{ NULL, NULL }, /* Fl */
@@ -190,7 +187,7 @@ const struct valids mdoc_valids[MDOC_MAX] = {
{ NULL, posts_wline }, /* Op */
{ NULL, NULL }, /* Ot */
{ NULL, NULL }, /* Pa */
- { pres_rv, posts_rv }, /* Rv */
+ { pres_rv, NULL }, /* Rv */
{ NULL, posts_st }, /* St */
{ NULL, NULL }, /* Va */
{ NULL, posts_text }, /* Vt */
@@ -922,16 +919,6 @@ post_an(POST_ARGS)
static int
-post_args(POST_ARGS)
-{
-
- if (mdoc->last->args)
- return(1);
- return(mdoc_nerr(mdoc, mdoc->last, ELINE));
-}
-
-
-static int
post_it(POST_ARGS)
{
int type, i, cols;