From e34eebeaa729c7d5cc258b87d5a6edd409cfaea2 Mon Sep 17 00:00:00 2001 From: Kristaps Dzonsons Date: Sat, 4 Sep 2010 19:01:52 +0000 Subject: [PATCH] Properly handle -mdoc %A in all outputs. This has two-author entires separated by only "and" while two or more are with ", and" for the last author. Also remove relevant TODO and add regression tests. --- TODO | 8 +------- mdoc_html.c | 11 ++++++++++- mdoc_term.c | 28 ++++++++++++++++++++++++++-- regress/mdoc/Rs/one_author.in | 15 +++++++++++++++ regress/mdoc/Rs/three_authors.in | 17 +++++++++++++++++ regress/mdoc/Rs/two_authors.in | 16 ++++++++++++++++ 6 files changed, 85 insertions(+), 10 deletions(-) create mode 100644 regress/mdoc/Rs/one_author.in create mode 100644 regress/mdoc/Rs/three_authors.in create mode 100644 regress/mdoc/Rs/two_authors.in diff --git a/TODO b/TODO index 9744c444..5bc6b596 100644 --- a/TODO +++ b/TODO @@ -1,6 +1,6 @@ ************************************************************************ * Official mandoc TODO. -* $Id: TODO,v 1.43 2010/09/04 18:52:21 kristaps Exp $ +* $Id: TODO,v 1.44 2010/09/04 19:01:52 kristaps Exp $ ************************************************************************ ************************************************************************ @@ -90,8 +90,6 @@ try e.g. .Bl -column It Ta Ta reported by millert Fri, 02 Apr 2010 16:13:46 -0400 -- %A doesn't put an "and" before the final author name. - ************************************************************************ * formatting issues: gratuitious differences ************************************************************************ @@ -107,10 +105,6 @@ Opening punctuation should not fall out of .Ns. see for example OpenBSD csh(1) -- .%A should append the last author with " and " (if there are two) - or ", and " (if there are more), not ", " - see for example OpenBSD csh(1) - - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet is just "o\bo". see for example OpenBSD ksh(1) diff --git a/mdoc_html.c b/mdoc_html.c index 1ee5c076..59be4e98 100644 --- a/mdoc_html.c +++ b/mdoc_html.c @@ -1,4 +1,4 @@ -/* $Id: mdoc_html.c,v 1.102 2010/08/20 01:02:07 schwarze Exp $ */ +/* $Id: mdoc_html.c,v 1.103 2010/09/04 19:01:52 kristaps Exp $ */ /* * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons * @@ -2194,6 +2194,9 @@ mdoc__x_pre(MDOC_ARGS) switch (n->tok) { case(MDOC__A): PAIR_CLASS_INIT(&tag[0], "ref-auth"); + if (n->prev && MDOC__A == n->prev->tok) + if (NULL == n->next || MDOC__A != n->next->tok) + print_text(h, "and"); break; case(MDOC__B): PAIR_CLASS_INIT(&tag[0], "ref-book"); @@ -2246,6 +2249,7 @@ mdoc__x_pre(MDOC_ARGS) PAIR_HREF_INIT(&tag[1], n->child->string); print_otag(h, TAG_A, 2, tag); + return(1); } @@ -2255,6 +2259,11 @@ static void mdoc__x_post(MDOC_ARGS) { + if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok) + if (NULL == n->next->next || MDOC__A != n->next->next->tok) + if (NULL == n->prev || MDOC__A != n->prev->tok) + return; + /* TODO: %U */ h->flags |= HTML_NOSPACE; diff --git a/mdoc_term.c b/mdoc_term.c index ba16bbc2..ca865c4f 100644 --- a/mdoc_term.c +++ b/mdoc_term.c @@ -1,4 +1,4 @@ -/* $Id: mdoc_term.c,v 1.183 2010/08/21 14:04:13 schwarze Exp $ */ +/* $Id: mdoc_term.c,v 1.184 2010/09/04 19:01:52 kristaps Exp $ */ /* * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons * Copyright (c) 2010 Ingo Schwarze @@ -92,6 +92,7 @@ static void termp_sh_post(DECL_ARGS); static void termp_sq_post(DECL_ARGS); static void termp_ss_post(DECL_ARGS); +static int termp__a_pre(DECL_ARGS); static int termp_an_pre(DECL_ARGS); static int termp_ap_pre(DECL_ARGS); static int termp_aq_pre(DECL_ARGS); @@ -178,7 +179,7 @@ static const struct termact termacts[MDOC_MAX] = { { termp_under_pre, NULL }, /* Va */ { termp_vt_pre, NULL }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ - { NULL, termp____post }, /* %A */ + { termp__a_pre, termp____post }, /* %A */ { termp_under_pre, termp____post }, /* %B */ { NULL, termp____post }, /* %D */ { termp_under_pre, termp____post }, /* %I */ @@ -1077,6 +1078,19 @@ termp_fl_pre(DECL_ARGS) } +/* ARGSUSED */ +static int +termp__a_pre(DECL_ARGS) +{ + + if (n->prev && MDOC__A == n->prev->tok) + if (NULL == n->next || MDOC__A != n->next->tok) + term_word(p, "and"); + + return(1); +} + + /* ARGSUSED */ static int termp_an_pre(DECL_ARGS) @@ -2098,6 +2112,16 @@ static void termp____post(DECL_ARGS) { + /* + * Handle lists of authors. In general, print each followed by + * a comma. Don't print the comma if there are only two + * authors. + */ + if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok) + if (NULL == n->next->next || MDOC__A != n->next->next->tok) + if (NULL == n->prev || MDOC__A != n->prev->tok) + return; + /* TODO: %U. */ p->flags |= TERMP_NOSPACE; diff --git a/regress/mdoc/Rs/one_author.in b/regress/mdoc/Rs/one_author.in new file mode 100644 index 00000000..98934ec0 --- /dev/null +++ b/regress/mdoc/Rs/one_author.in @@ -0,0 +1,15 @@ +.Dd May 1, 2009 +.Dt FOO 1 +.Os +.Sh NAME +.Nm foo +.Nd bar +.Sh DESCRIPTION +blah blah +.Pp +.Rs +.%A joe +.%T title +.Re +.Pp +and so on diff --git a/regress/mdoc/Rs/three_authors.in b/regress/mdoc/Rs/three_authors.in new file mode 100644 index 00000000..245023c5 --- /dev/null +++ b/regress/mdoc/Rs/three_authors.in @@ -0,0 +1,17 @@ +.Dd May 1, 2009 +.Dt FOO 1 +.Os +.Sh NAME +.Nm foo +.Nd bar +.Sh DESCRIPTION +blah blah +.Pp +.Rs +.%A billy-bob +.%A joe +.%A frank +.%T title +.Re +.Pp +and so on diff --git a/regress/mdoc/Rs/two_authors.in b/regress/mdoc/Rs/two_authors.in new file mode 100644 index 00000000..d1a74f27 --- /dev/null +++ b/regress/mdoc/Rs/two_authors.in @@ -0,0 +1,16 @@ +.Dd May 1, 2009 +.Dt FOO 1 +.Os +.Sh NAME +.Nm foo +.Nd bar +.Sh DESCRIPTION +blah blah +.Pp +.Rs +.%A joe +.%A frank +.%T title +.Re +.Pp +and so on -- 2.47.1