source@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: kristaps@mdocml.bsd.lv
To: source@mdocml.bsd.lv
Subject: mdocml: Move `Sh' validation from mdoc_action.c.
Date: Mon, 29 Nov 2010 08:51:03 -0500 (EST)	[thread overview]
Message-ID: <201011291351.oATDp3Nm011799@krisdoz.my.domain> (raw)

Log Message:
-----------
Move `Sh' validation from mdoc_action.c. into mdoc_validate.c.
Surprisingly, both functions were doing pretty much the same thing.
Make sure that the changes incorporate the union of both.

Modified Files:
--------------
    mdocml:
        mdoc_action.c
        mdoc_validate.c

Revision Data
-------------
Index: mdoc_validate.c
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc_validate.c,v
retrieving revision 1.124
retrieving revision 1.125
diff -Lmdoc_validate.c -Lmdoc_validate.c -u -p -r1.124 -r1.125
--- mdoc_validate.c
+++ mdoc_validate.c
@@ -1544,34 +1544,33 @@ post_sh_body(POST_ARGS)
 static int
 post_sh_head(POST_ARGS)
 {
-	char		        buf[BUFSIZ];
-	enum mdoc_sec	        sec;
-	const struct mdoc_node *n;
+	char		  buf[BUFSIZ];
+	enum mdoc_sec	  sec;
+	struct mdoc_node *n;
 
 	/*
 	 * Process a new section.  Sections are either "named" or
-	 * "custom"; custom sections are user-defined, while named ones
-	 * usually follow a conventional order and may only appear in
-	 * certain manual sections.
+	 * "custom".  Custom sections are user-defined, while named ones
+	 * follow a conventional order and may only appear in certain
+	 * manual sections.
 	 */
 
 	buf[0] = '\0';
 
-	/*
-	 * FIXME: yes, these can use a dynamic buffer, but I don't do so
-	 * in the interests of simplicity.
-	 */
+	/* FIXME: use dynamic buffer... */
 
 	for (n = mdoc->last->child; n; n = n->next) {
-		/* XXX - copied from compact(). */
+		/* XXX - copied from concat(). */
 		assert(MDOC_TEXT == n->type);
 
 		if (strlcat(buf, n->string, BUFSIZ) >= BUFSIZ) {
 			mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
 			return(0);
 		}
+
 		if (NULL == n->next)
 			continue;
+
 		if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
 			mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
 			return(0);
@@ -1580,41 +1579,60 @@ post_sh_head(POST_ARGS)
 
 	sec = mdoc_str2sec(buf);
 
-	/* 
-	 * Check: NAME should always be first, CUSTOM has no roles,
-	 * non-CUSTOM has a conventional order to be followed.
-	 */
+	/* The NAME should be first. */
 
 	if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
-		if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST))
-			return(0);
+		mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST);
+
+	/* The SYNOPSIS gets special attention in other areas. */
+
+	if (SEC_SYNOPSIS == sec)
+		mdoc->flags |= MDOC_SYNOPSIS;
+	else
+		mdoc->flags &= ~MDOC_SYNOPSIS;
+
+	/* Mark our last section. */
+
+	mdoc->lastsec = sec;
+
+	/* We don't care about custom sections after this. */
 
 	if (SEC_CUSTOM == sec)
 		return(1);
 
+	/*
+	 * Check whether our non-custom section is being repeated or is
+	 * out of order.
+	 */
+
 	if (sec == mdoc->lastnamed)
-		if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP))
-			return(0);
+		mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP);
 
 	if (sec < mdoc->lastnamed)
-		if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO))
-			return(0);
+		mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO);
 
-	/* 
-	 * Check particular section/manual conventions.  LIBRARY can
-	 * only occur in manual section 2, 3, and 9.
-	 */
+	/* Mark the last named section. */
+
+	mdoc->lastnamed = sec;
+
+	/* Check particular section/manual conventions. */
+
+	assert(mdoc->meta.msec);
 
 	switch (sec) {
+	case (SEC_RETURN_VALUES):
+		/* FALLTHROUGH */
+	case (SEC_ERRORS):
+		/* FALLTHROUGH */
 	case (SEC_LIBRARY):
-		assert(mdoc->meta.msec);
 		if (*mdoc->meta.msec == '2')
 			break;
 		if (*mdoc->meta.msec == '3')
 			break;
 		if (*mdoc->meta.msec == '9')
 			break;
-		return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC));
+		mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC);
+		break;
 	default:
 		break;
 	}
Index: mdoc_action.c
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc_action.c,v
retrieving revision 1.80
retrieving revision 1.81
diff -Lmdoc_action.c -Lmdoc_action.c -u -p -r1.80 -r1.81
--- mdoc_action.c
+++ mdoc_action.c
@@ -64,7 +64,6 @@ static	int	  post_nm(POST_ARGS);
 static	int	  post_os(POST_ARGS);
 static	int	  post_pa(POST_ARGS);
 static	int	  post_prol(POST_ARGS);
-static	int	  post_sh(POST_ARGS);
 static	int	  post_st(POST_ARGS);
 static	int	  post_std(POST_ARGS);
 
@@ -76,7 +75,7 @@ static	const struct actions mdoc_actions
 	{ NULL, post_dd }, /* Dd */ 
 	{ NULL, post_dt }, /* Dt */ 
 	{ NULL, post_os }, /* Os */ 
-	{ NULL, post_sh }, /* Sh */ 
+	{ NULL, NULL }, /* Sh */ 
 	{ NULL, NULL }, /* Ss */ 
 	{ NULL, NULL }, /* Pp */ 
 	{ NULL, NULL }, /* D1 */
@@ -424,63 +423,6 @@ post_at(POST_ARGS)
 	if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
 		return(0);
 	m->last = nn;
-	return(1);
-}
-
-
-/*
- * Mark the current section.  The ``named'' section (lastnamed) is set
- * whenever the current section isn't a custom section--we use this to
- * keep track of section ordering.  Also check that the section is
- * allowed within the document's manual section.
- */
-static int
-post_sh(POST_ARGS)
-{
-	enum mdoc_sec	 sec;
-	char		 buf[BUFSIZ];
-
-	if (MDOC_HEAD != n->type)
-		return(1);
-
-	if ( ! concat(m, buf, n->child, BUFSIZ))
-		return(0);
-	sec = mdoc_str2sec(buf);
-	/*
-	 * The first section should always make us move into a non-new
-	 * state.
-	 */
-	if (SEC_NONE == m->lastnamed || SEC_CUSTOM != sec)
-		m->lastnamed = sec;
-
-	/*
-	 * Switch the parser's SYNOPSIS mode, to be copied
-	 * into individual nodes when creating them.
-	 * Note that this mode can also be set and unset
-	 * using the roff nS register.
-	 */
-	if (SEC_SYNOPSIS == sec)
-		m->flags |= MDOC_SYNOPSIS;
-	else
-		m->flags &= ~MDOC_SYNOPSIS;
-
-	/* Some sections only live in certain manual sections. */
-
-	switch ((m->lastsec = sec)) {
-	case (SEC_RETURN_VALUES):
-		/* FALLTHROUGH */
-	case (SEC_ERRORS):
-		assert(m->meta.msec);
-		if (*m->meta.msec == '2')
-			break;
-		if (*m->meta.msec == '3')
-			break;
-		if (*m->meta.msec == '9')
-			break;
-		return(mdoc_nmsg(m, n, MANDOCERR_SECMSEC));
-	default:
-		break;
-	}
 	return(1);
 }
 
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv

                 reply	other threads:[~2010-11-29 13:51 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=201011291351.oATDp3Nm011799@krisdoz.my.domain \
    --to=kristaps@mdocml.bsd.lv \
    --cc=source@mdocml.bsd.lv \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).