From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from localhost (fantadrom.bsd.lv [local]) by fantadrom.bsd.lv (OpenSMTPD) with ESMTPA id d0c421d2 for ; Sun, 21 Apr 2019 17:49:00 -0500 (EST) Date: Sun, 21 Apr 2019 17:49:00 -0500 (EST) X-Mailinglist: mandoc-source Reply-To: source@mandoc.bsd.lv MIME-Version: 1.0 From: schwarze@mandoc.bsd.lv To: source@mandoc.bsd.lv Subject: mandoc: Implement the roff .break request (break out of a .while loop). X-Mailer: activitymail 1.26, http://search.cpan.org/dist/activitymail/ Content-Type: text/plain; charset=utf-8 Message-ID: Log Message: ----------- Implement the roff .break request (break out of a .while loop). Jan Stary found it in an ancient groffer(1) manual page (version 1.19) on MacOS X Mojave. Having .break not implemented wasn't a particularly bright idea because obviously, it tended to cause infinite loops. Modified Files: -------------- mandoc: roff.7 roff.c mandoc/regress/roff/while: Makefile Added Files: ----------- mandoc/regress/roff/while: break.in break.out_ascii Revision Data ------------- Index: roff.7 =================================================================== RCS file: /home/cvs/mandoc/mandoc/roff.7,v retrieving revision 1.111 retrieving revision 1.112 diff -Lroff.7 -Lroff.7 -u -p -r1.111 -r1.112 --- roff.7 +++ roff.7 @@ -503,10 +503,9 @@ This is a Heirloom extension and current .It Ic \&br Break the output line. .It Ic \&break -Break out of a +Break out of the innermost .Ic \&while loop. -Currently unsupported. .It Ic \&breakchar Ar char ... Optional line break characters. This is a Heirloom extension and currently ignored. Index: roff.c =================================================================== RCS file: /home/cvs/mandoc/mandoc/roff.c,v retrieving revision 1.363 retrieving revision 1.364 diff -Lroff.c -Lroff.c -u -p -r1.363 -r1.364 --- roff.c +++ roff.c @@ -133,15 +133,18 @@ struct roff { char escape; /* escape character */ }; +/* + * A macro definition, condition, or ignored block. + */ struct roffnode { enum roff_tok tok; /* type of node */ struct roffnode *parent; /* up one in stack */ int line; /* parse line */ int col; /* parse col */ char *name; /* node name, e.g. macro name */ - char *end; /* end-rules: custom token */ - int endspan; /* end-rules: next-line or infty */ - int rule; /* current evaluation rule */ + char *end; /* custom end macro of the block */ + int endspan; /* scope to: 1=eol 2=next line -1=\} */ + int rule; /* content is: 1=evaluated 0=skipped */ }; #define ROFF_ARGS struct roff *r, /* parse ctx */ \ @@ -181,6 +184,7 @@ static int roff_als(ROFF_ARGS); static int roff_block(ROFF_ARGS); static int roff_block_text(ROFF_ARGS); static int roff_block_sub(ROFF_ARGS); +static int roff_break(ROFF_ARGS); static int roff_cblock(ROFF_ARGS); static int roff_cc(ROFF_ARGS); static int roff_ccond(struct roff *, int, int); @@ -400,7 +404,7 @@ static struct roffmac roffs[TOKEN_NONE] { roff_unsupp, NULL, NULL, 0 }, /* boxa */ { roff_line_ignore, NULL, NULL, 0 }, /* bp */ { roff_unsupp, NULL, NULL, 0 }, /* BP */ - { roff_unsupp, NULL, NULL, 0 }, /* break */ + { roff_break, NULL, NULL, 0 }, /* break */ { roff_line_ignore, NULL, NULL, 0 }, /* breakchar */ { roff_line_ignore, NULL, NULL, 0 }, /* brnl */ { roff_noarg, NULL, NULL, 0 }, /* brp */ @@ -685,7 +689,7 @@ roffhash_find(struct ohash *htab, const /* * Pop the current node off of the stack of roff instructions currently - * pending. + * pending. Return 1 if it is a loop or 0 otherwise. */ static int roffnode_pop(struct roff *r) @@ -2002,6 +2006,10 @@ roff_cblock(ROFF_ARGS) } +/* + * Pop all nodes ending at the end of the current input line. + * Return the number of loops ended. + */ static int roffnode_cleanscope(struct roff *r) { @@ -2016,6 +2024,11 @@ roffnode_cleanscope(struct roff *r) return inloop; } +/* + * Handle the closing \} of a conditional block. + * Apart from generating warnings, this only pops nodes. + * Return the number of loops ended. + */ static int roff_ccond(struct roff *r, int ln, int ppos) { @@ -2235,6 +2248,7 @@ roff_block_text(ROFF_ARGS) static int roff_cond_sub(ROFF_ARGS) { + struct roffnode *bl; char *ep; int endloop, irc, rr; enum roff_tok t; @@ -2282,9 +2296,21 @@ roff_cond_sub(ROFF_ARGS) */ t = roff_parse(r, buf->buf, &pos, ln, ppos); - irc |= t != TOKEN_NONE && (rr || roffs[t].flags & ROFFMAC_STRUCT) ? - (*roffs[t].proc)(r, t, buf, ln, ppos, pos, offs) : - rr ? ROFF_CONT : ROFF_IGN; + if (t == ROFF_break) { + if (irc & ROFF_LOOPMASK) + irc = ROFF_IGN | ROFF_LOOPEXIT; + else if (rr) { + for (bl = r->last; bl != NULL; bl = bl->parent) { + bl->rule = 0; + if (bl->tok == ROFF_while) + break; + } + } + } else if (t != TOKEN_NONE && + (rr || roffs[t].flags & ROFFMAC_STRUCT)) + irc |= (*roffs[t].proc)(r, t, buf, ln, ppos, pos, offs); + else + irc |= rr ? ROFF_CONT : ROFF_IGN; return irc; } @@ -3479,6 +3505,17 @@ roff_als(ROFF_ARGS) roff_setstrn(&r->strtab, newn, newsz, value, valsz, 0); roff_setstrn(&r->rentab, newn, newsz, NULL, 0, 0); free(value); + return ROFF_IGN; +} + +/* + * The .break request only makes sense inside conditionals, + * and that case is already handled in roff_cond_sub(). + */ +static int +roff_break(ROFF_ARGS) +{ + mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, pos, "break"); return ROFF_IGN; } Index: Makefile =================================================================== RCS file: /home/cvs/mandoc/mandoc/regress/roff/while/Makefile,v retrieving revision 1.1 retrieving revision 1.2 diff -Lregress/roff/while/Makefile -Lregress/roff/while/Makefile -u -p -r1.1 -r1.2 --- regress/roff/while/Makefile +++ regress/roff/while/Makefile @@ -1,6 +1,6 @@ -# $OpenBSD: Makefile,v 1.1 2018/08/24 22:56:37 schwarze Exp $ +# $OpenBSD: Makefile,v 1.2 2019/04/21 22:43:00 schwarze Exp $ -REGRESS_TARGETS = basic badargs into nesting outof +REGRESS_TARGETS = basic badargs break into nesting outof LINT_TARGETS = badargs into nesting outof # mandoc defects: --- /dev/null +++ regress/roff/while/break.out_ascii @@ -0,0 +1,9 @@ +WHILE-BREAK(1) General Commands Manual WHILE-BREAK(1) + +NNAAMMEE + wwhhiillee--bbrreeaakk - break request inside a while loop + +DDEESSCCRRIIPPTTIIOONN + initial text 10 - 9 - 8 - 7 - 6 - 5 - 4 - 3 - 2 - 1 - 0 final text + +OpenBSD April 21, 2019 OpenBSD --- /dev/null +++ regress/roff/while/break.in @@ -0,0 +1,16 @@ +.\" $OpenBSD: break.in,v 1.1 2019/04/21 22:43:00 schwarze Exp $ +.Dd $Mdocdate: April 21 2019 $ +.Dt WHILE-BREAK 1 +.Os +.Sh NAME +.Nm while-break +.Nd break request inside a while loop +.Sh DESCRIPTION +initial text +.nr cnt 11 1 +.while n \{\ +\n-[cnt] +.if !\n[cnt] .break +\(en +.\} +final text -- To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv