source@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: schwarze@mandoc.bsd.lv
To: source@mandoc.bsd.lv
Subject: mandoc: Fix two issues with .po (page offset) formatting: 1.
Date: Thu, 3 Sep 2020 15:43:18 -0500 (EST)	[thread overview]
Message-ID: <f200da637227227e@mandoc.bsd.lv> (raw)

Log Message:
-----------
Fix two issues with .po (page offset) formatting:
1. Truncate excessive offsets to a width reasonable in the context
of manual pages instead of printing excessively long lines
and sometimes causing assertion failures;
found in an afl run performed by Jan Schreiber <jes at posteo dot de>.
2. Remember both the requested and the applied page offset; otherwise,
subtracting an excessive width, then adding it again, would end up
with an incorrectly large offset.
While here, simplify the code by reverting the previous offset up front,
and also add some comments to make the general ideas easier to understand.

Modified Files:
--------------
    mandoc:
        roff_term.c
    mandoc/regress/roff/po:
        Makefile

Added Files:
-----------
    mandoc/regress/roff/po:
        range.in
        range.out_ascii

Revision Data
-------------
Index: roff_term.c
===================================================================
RCS file: /home/cvs/mandoc/mandoc/roff_term.c,v
retrieving revision 1.21
retrieving revision 1.22
diff -Lroff_term.c -Lroff_term.c -u -p -r1.21 -r1.22
--- roff_term.c
+++ roff_term.c
@@ -1,6 +1,6 @@
-/* $Id$ */
+/* $OpenBSD: roff_term.c,v 1.20 2020/09/03 17:37:06 schwarze Exp $ */
 /*
- * Copyright (c) 2010,2014,2015,2017-2019 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010,2014,2015,2017-2020 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
@@ -157,9 +157,13 @@ static void
 roff_term_pre_po(ROFF_TERM_ARGS)
 {
 	struct roffsu	 su;
-	static int	 po, polast;
+	static int	 po, pouse, polast;
 	int		 ponew;
 
+	/* Revert the currently active page offset. */
+	p->tcol->offset -= pouse;
+
+	/* Determine the requested page offset. */
 	if (n->child != NULL &&
 	    a2roffsu(n->child->string, &su, SCALE_EM) != NULL) {
 		ponew = term_hen(p, &su);
@@ -168,11 +172,15 @@ roff_term_pre_po(ROFF_TERM_ARGS)
 			ponew += po;
 	} else
 		ponew = polast;
+
+	/* Remeber both the previous and the newly requested offset. */
 	polast = po;
 	po = ponew;
 
-	ponew = po - polast + (int)p->tcol->offset;
-	p->tcol->offset = ponew > 0 ? ponew : 0;
+	/* Truncate to the range [-offset, 60], remember, and apply it. */
+	pouse = po >= 60 ? 60 :
+	    po < -(int)p->tcol->offset ? -p->tcol->offset : po;
+	p->tcol->offset += pouse;
 }
 
 static void
--- /dev/null
+++ regress/roff/po/range.in
@@ -0,0 +1,24 @@
+.\" $OpenBSD: range.in,v 1.1 2020/09/03 20:33:20 schwarze Exp $
+.Dd $Mdocdate: September 3 2020 $
+.Dt PO-RANGE 1
+.Os
+.Sh NAME
+.Nm po-range
+.Nd page offsets out of range
+.Sh DESCRIPTION
+initial text
+.Pp
+.po -10n
+too small
+.Pp
+.po +10n
+back in range
+.Pp
+.po 80n
+too large
+.Pp
+.po -70n
+back in range
+.Pp
+.po 0
+final text
--- /dev/null
+++ regress/roff/po/range.out_ascii
@@ -0,0 +1,19 @@
+PO-RANGE(1)                 General Commands Manual                PO-RANGE(1)
+
+N\bNA\bAM\bME\bE
+     p\bpo\bo-\b-r\bra\ban\bng\bge\be - page offsets out of range
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+     initial text
+
+too small
+
+     back in range
+
+                                                                 too large
+
+               back in range
+
+     final text
+
+OpenBSD                        September 3, 2020                       OpenBSD
Index: Makefile
===================================================================
RCS file: /home/cvs/mandoc/mandoc/regress/roff/po/Makefile,v
retrieving revision 1.1
retrieving revision 1.2
diff -Lregress/roff/po/Makefile -Lregress/roff/po/Makefile -u -p -r1.1 -r1.2
--- regress/roff/po/Makefile
+++ regress/roff/po/Makefile
@@ -1,5 +1,13 @@
-# $OpenBSD: Makefile,v 1.1 2017/05/08 15:33:43 schwarze Exp $
+# $OpenBSD: Makefile,v 1.2 2020/09/03 20:33:20 schwarze Exp $
 
-REGRESS_TARGETS	= basic-mdoc
+REGRESS_TARGETS	= basic-mdoc range
+
+# groff-1.22.4 defect:
+# - Negative page objects sometimes result in output lines starting
+#   with backspace characters.
+# - Excessive page offsets cause excessive line lengths
+#   instead of being truncated to resonable widths.
+
+SKIP_GROFF	 = range
 
 .include <bsd.regress.mk>
--
 To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv


                 reply	other threads:[~2020-09-03 20:43 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=f200da637227227e@mandoc.bsd.lv \
    --to=schwarze@mandoc.bsd.lv \
    --cc=source@mandoc.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).