Re: Feature request for -Tlint

[Ingo Schwarze <schwarze@usta.de>]

Hi Anthony,

Anthony J. Bentley wrote on Thu, Oct 09, 2014 at 04:46:07PM -0600:

> When converting old manual pages to mdoc(7), it's easy to accidentally
> leave the trailing parentheses in the first argument to a Fn macro.
> A warning when this happens would be nice.
> 
> .\" oops, wrong!
> .Fn client_cert_cb()
> 
> .\" right
> .Fn client_cert_cb
> 
> Not sure if this is the domain of mandoc -Tlint

My opinion is that it is well in scope for mandoc.

> or if it would be better
> implemented in a helper tool like igor(1).

Igor's main strength is catching spelling errors, typos, and bad
phrases.  It's doing some syntactic checking, too, but not as
thoroughly as mandoc.

> Of course, parentheses are allowed in arguments besides the first
> argument, but I can't think of any case where they're needed in
> the first one.

Me neither, so i have committed the following patch.

Thanks for the suggestion,
  Ingo


Log Message:
-----------
warn about parentheses in function names after .Fn and .Fo;
particularly useful when converting from other languages to mdoc(7);
feature suggested by bentley@

Modified Files:
--------------
    mdocml:
        mandoc.1
        mandoc.h
        mdoc_validate.c
        read.c

Revision Data
-------------
Index: mandoc.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc.1,v
retrieving revision 1.116
retrieving revision 1.117
diff -Lmandoc.1 -Lmandoc.1 -u -p -r1.116 -r1.117
--- mandoc.1
+++ mandoc.1
@@ -1120,6 +1120,14 @@ An argument of an
 or
 .Ic \&Fn
 macro contains a comma; it should probably be split into two arguments.
+.It Sy "parenthesis in function name"
+.Pq mdoc
+The first argument of an
+.Ic \&Fc
+or
+.Ic \&Fn
+macro contains an opening or closing parenthesis; that's probably wrong,
+parentheses are added automatically.
 .It Sy "invalid content in Rs block"
 .Pq mdoc
 An
Index: mdoc_validate.c
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc_validate.c,v
retrieving revision 1.249
retrieving revision 1.250
diff -Lmdoc_validate.c -Lmdoc_validate.c -u -p -r1.249 -r1.250
--- mdoc_validate.c
+++ mdoc_validate.c
@@ -101,6 +101,8 @@ static	int	 post_es(POST_ARGS);
 static	int	 post_eoln(POST_ARGS);
 static	int	 post_ex(POST_ARGS);
 static	int	 post_fa(POST_ARGS);
+static	int	 post_fn(POST_ARGS);
+static	int	 post_fname(POST_ARGS);
 static	int	 post_fo(POST_ARGS);
 static	int	 post_hyph(POST_ARGS);
 static	int	 post_hyphtext(POST_ARGS);
@@ -161,7 +163,7 @@ static	const struct valids mdoc_valids[M
 	{ NULL, post_fa },			/* Fa */
 	{ NULL, ewarn_ge1 },			/* Fd */
 	{ NULL, NULL },				/* Fl */
-	{ NULL, post_fa },			/* Fn */
+	{ NULL, post_fn },			/* Fn */
 	{ NULL, NULL },				/* Ft */
 	{ NULL, NULL },				/* Ic */
 	{ NULL, ewarn_eq1 },			/* In */
@@ -1000,11 +1002,36 @@ post_eoln(POST_ARGS)
 }
 
 static int
+post_fname(POST_ARGS)
+{
+	const struct mdoc_node *n;
+	size_t pos;
+
+	n = mdoc->last->child;
+	pos = strcspn(n->string, "()");
+	if (n->string[pos] != '\0')
+		mandoc_msg(MANDOCERR_FN_PAREN, mdoc->parse,
+		    n->line, n->pos + pos, n->string);
+	return(1);
+}
+
+static int
+post_fn(POST_ARGS)
+{
+
+	post_fname(mdoc);
+	post_fa(mdoc);
+	return(1);
+}
+
+static int
 post_fo(POST_ARGS)
 {
 
 	hwarn_eq1(mdoc);
 	bwarn_ge1(mdoc);
+	if (mdoc->last->type == MDOC_HEAD)
+		post_fname(mdoc);
 	return(1);
 }
 
Index: mandoc.h
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc.h,v
retrieving revision 1.160
retrieving revision 1.161
diff -Lmandoc.h -Lmandoc.h -u -p -r1.160 -r1.161
--- mandoc.h
+++ mandoc.h
@@ -114,6 +114,7 @@ enum	mandocerr {
 	MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
 	MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
 	MANDOCERR_FA_COMMA, /* comma in function argument: arg */
+	MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
 	MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
 	MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
 	MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
Index: read.c
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/read.c,v
retrieving revision 1.88
retrieving revision 1.89
diff -Lread.c -Lread.c -u -p -r1.88 -r1.89
--- read.c
+++ read.c
@@ -159,6 +159,7 @@ static	const char * const	mandocerrs[MAN
 	"skipping -width argument",
 	"unknown AT&T UNIX version",
 	"comma in function argument",
+	"parenthesis in function name",
 	"invalid content in Rs block",
 	"invalid Boolean argument",
 	"unknown font, skipping request",
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv