source@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: schwarze@mandoc.bsd.lv
To: source@mandoc.bsd.lv
Subject: mandoc: Surprisingly, groff supports multiple copy mode escapes at the
Date: Wed, 13 Apr 2022 08:20:07 -0500 (EST)	[thread overview]
Message-ID: <336500f0273f59f4@mandoc.bsd.lv> (raw)

Log Message:
-----------
Surprisingly, groff supports multiple copy mode escapes at the
beginning of an escape sequence: \, \E, \EE, \EEE, and so on all do
the same outside copy mode, so let them do the same in mandoc(1), too.

This fixes an assertion failure triggered by \EE*X that tb@ found
with afl(1).  The first E was consumed by roff_expand(), but that
function failed to recognize the escape sequence as the expansion
of a user-defined string and handed it over to mandoc_escape(),
which consumed the second E and then died on an assertion because
it is not prepared to handle user-defined strings.  Fix this by
letting *both* functions handle arbitrary numbers of 'E's correctly.

Modified Files:
--------------
    mandoc:
        mandoc.c
        roff.c
    mandoc/regress/roff/esc:
        Makefile

Added Files:
-----------
    mandoc/regress/roff/esc:
        E1.in
        E1.out_ascii

Revision Data
-------------
Index: mandoc.c
===================================================================
RCS file: /home/cvs/mandoc/mandoc/mandoc.c,v
retrieving revision 1.119
retrieving revision 1.120
diff -Lmandoc.c -Lmandoc.c -u -p -r1.119 -r1.120
--- mandoc.c
+++ mandoc.c
@@ -1,7 +1,7 @@
-/*	$Id$ */
+/* $Id$ */
 /*
+ * Copyright (c) 2011-2015, 2017-2022 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2011-2015, 2017-2021 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -114,7 +114,7 @@ mandoc_escape(const char **end, const ch
 	 * it only makes a difference in copy mode.
 	 */
 
-	if (**end == 'E')
+	while (**end == 'E')
 		++*end;
 
 	/*
Index: roff.c
===================================================================
RCS file: /home/cvs/mandoc/mandoc/roff.c,v
retrieving revision 1.380
retrieving revision 1.381
diff -Lroff.c -Lroff.c -u -p -r1.380 -r1.381
--- roff.c
+++ roff.c
@@ -1,6 +1,6 @@
 /* $Id$ */
 /*
- * Copyright (c) 2010-2015, 2017-2021 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2015, 2017-2022 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -1401,7 +1401,7 @@ roff_expand(struct roff *r, struct buf *
 
 		term = '\0';
 		cp = stesc + 1;
-		if (*cp == 'E')
+		while (*cp == 'E')
 			cp++;
 		esct = cp;
 		switch (*esct) {
Index: Makefile
===================================================================
RCS file: /home/cvs/mandoc/mandoc/regress/roff/esc/Makefile,v
retrieving revision 1.7
retrieving revision 1.8
diff -Lregress/roff/esc/Makefile -Lregress/roff/esc/Makefile -u -p -r1.7 -r1.8
--- regress/roff/esc/Makefile
+++ regress/roff/esc/Makefile
@@ -1,6 +1,6 @@
-# $OpenBSD: Makefile,v 1.17 2020/12/21 14:55:58 schwarze Exp $
+# $OpenBSD: Makefile,v 1.18 2022/04/13 13:11:33 schwarze Exp $
 
-REGRESS_TARGETS	 = one two multi B bs_man bs_mdoc c c_man e f h l O1 o p w z
+REGRESS_TARGETS	 = one two multi B bs_man bs_mdoc c c_man E1 e f h l O1 o p w z
 REGRESS_TARGETS	+= ignore invalid unsupp
 HTML_TARGETS	 = f
 LINT_TARGETS	 = B h l O1 w ignore invalid unsupp
--- /dev/null
+++ regress/roff/esc/E1.out_ascii
@@ -0,0 +1,21 @@
+ESC-E(1)                    General Commands Manual                   ESC-E(1)
+
+N\bNA\bAM\bME\bE
+     e\bes\bsc\bc-\b-E\bE - copy-mode escaping of backslashes
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+     initial text
+
+     string expansion: myval myval myval myval
+
+     output device: ascii ascii ascii ascii
+
+     numerical expression test: 1 0 1 0
+
+     register: 1 2 3 3
+
+     special character: <= >= << >>
+
+     final text
+
+OpenBSD                         April 13, 2022                         OpenBSD
--- /dev/null
+++ regress/roff/esc/E1.in
@@ -0,0 +1,27 @@
+.\" $OpenBSD: E1.in,v 1.1 2022/04/13 13:11:33 schwarze Exp $
+.Dd $Mdocdate: April 13 2022 $
+.Dt ESC-E 1
+.Os
+.Sh NAME
+.Nm esc-E
+.Nd copy-mode escaping of backslashes
+.Sh DESCRIPTION
+.ds myvar myval
+.nr myreg 1 1
+initial text
+.Pp
+string expansion: \*[myvar] \E*[myvar] \EE*[myvar] \EEE*[myvar]
+.Pp
+output device: \*(.T \E*[.T] \EE*(.T \EEE*(.T
+.Pp
+numerical expression test: \B'1' \EB'X' \EEB'2' \EEEB'Y'
+.Pp
+register:
+\n[myreg]
+\En+[myreg]
+\EEn+[myreg]
+\EEEn[myreg]
+.Pp
+special character: \(<= \E(>= \EE(<< \EEE(>>
+.Pp
+final text
--
 To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv


                 reply	other threads:[~2022-04-13 13:20 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=336500f0273f59f4@mandoc.bsd.lv \
    --to=schwarze@mandoc.bsd.lv \
    --cc=source@mandoc.bsd.lv \
    --subject='Re: mandoc: Surprisingly, groff supports multiple copy mode escapes at the' \
    /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

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).