From f10f0fe3970de778125a29d73e65e63f32c138e1 Mon Sep 17 00:00:00 2001
From: Ingo Schwarze <schwarze@openbsd.org>
Date: Fri, 13 Mar 2020 15:32:28 +0000
Subject: Split tagging into a validation part including prioritization in
 tag.{h,c} and {mdoc,man}_validate.c and into a formatting part including
 command line argument checking in term_tag.{h,c}, html.c, and
 {mdoc|man}_{term|html}.c.

Immediate functional benefits include:
* Improved prioritization of automatic tags for .Em and .Sy.
* Avoiding bogus automatic tags when .Em, .Fn, or .Sy are explicitly tagged.
* Explicit tagging of .Er and .Fl now works in HTML output.
* Automatic tagging of .IP and .TP now works in HTML output.
But mainly, this patch provides clean earth to build further improvements on.

Technical changes:
* Main program: Write a tag file for ASCII and UTF-8 output only.
* All formatters: There is no more need to delay writing the tags.
* mdoc(7)+man(7) formatters: No more need for elaborate syntax tree inspection.
* HTML formatter: If available, use the "string" attribute as the tag.
* HTML formatter: New function to write permalinks, to reduce code duplication.

Style cleanup in the vicinity while here:
* mdoc(7) terminal formatter: To set up bold font for children,
defer to termp_bold_pre() rather than calling term_fontpush() manually.
* mdoc(7) terminal formatter: Garbage collect some duplicate functions.
* mdoc(7) HTML formatter: Unify <code> handling, delete redundant functions.
* Where possible, use switch statements rather than if cascades.
* Get rid of some more Yoda notation.

The necessity for such changes was first discussed with kn@, but i didn't
bother him with a request to review the resulting -673/+782 line patch.
---
 regress/mdoc/Cm/Makefile         |  6 ++++--
 regress/mdoc/Cm/tag.in           | 21 +++++++++++++++++++++
 regress/mdoc/Cm/tag.out_ascii    | 17 +++++++++++++++++
 regress/mdoc/Cm/tag.out_html     |  9 +++++++++
 regress/mdoc/Cm/tag.out_markdown | 23 +++++++++++++++++++++++
 regress/mdoc/Cm/tag.out_tag      |  4 ++++
 6 files changed, 78 insertions(+), 2 deletions(-)
 create mode 100644 regress/mdoc/Cm/tag.in
 create mode 100644 regress/mdoc/Cm/tag.out_ascii
 create mode 100644 regress/mdoc/Cm/tag.out_html
 create mode 100644 regress/mdoc/Cm/tag.out_markdown
 create mode 100644 regress/mdoc/Cm/tag.out_tag

(limited to 'regress/mdoc/Cm')

diff --git a/regress/mdoc/Cm/Makefile b/regress/mdoc/Cm/Makefile
index 4b7066ec..7bc3fc20 100644
--- a/regress/mdoc/Cm/Makefile
+++ b/regress/mdoc/Cm/Makefile
@@ -1,6 +1,8 @@
-# $OpenBSD: Makefile,v 1.3 2014/07/02 20:18:42 schwarze Exp $
+# $OpenBSD: Makefile,v 1.7 2020/03/13 00:31:05 schwarze Exp $
 
-REGRESS_TARGETS = basic font noarg punct
+REGRESS_TARGETS = basic font noarg punct tag
+TAG_TARGETS	= tag
 LINT_TARGETS	= noarg
+HTML_TARGETS	= tag
 
 .include <bsd.regress.mk>
diff --git a/regress/mdoc/Cm/tag.in b/regress/mdoc/Cm/tag.in
new file mode 100644
index 00000000..3db1d1e0
--- /dev/null
+++ b/regress/mdoc/Cm/tag.in
@@ -0,0 +1,21 @@
+.\" $OpenBSD: tag.in,v 1.1 2020/03/13 00:31:05 schwarze Exp $
+.Dd $Mdocdate: March 13 2020 $
+.Dt CM-TAG 1
+.Os
+.Sh NAME
+.Nm Cm-tag
+.Nd tagging of command modifier macros
+.Sh DESCRIPTION
+BEGINTEST
+.Bl -tag -width Ds
+.It Cm one | two
+text
+.It Xo
+.Cm three
+.Xc
+text
+.El
+.Tg
+.Cm four
+.Pp
+ENDTEST
diff --git a/regress/mdoc/Cm/tag.out_ascii b/regress/mdoc/Cm/tag.out_ascii
new file mode 100644
index 00000000..071408c7
--- /dev/null
+++ b/regress/mdoc/Cm/tag.out_ascii
@@ -0,0 +1,17 @@
+CM-TAG(1)                   General Commands Manual                  CM-TAG(1)
+
+NNAAMMEE
+     CCmm--ttaagg - tagging of command modifier macros
+
+DDEESSCCRRIIPPTTIIOONN
+     BEGINTEST
+
+     oonnee | ttwwoo
+             text
+
+     tthhrreeee   text
+     ffoouurr
+
+     ENDTEST
+
+OpenBSD                         March 13, 2020                         OpenBSD
diff --git a/regress/mdoc/Cm/tag.out_html b/regress/mdoc/Cm/tag.out_html
new file mode 100644
index 00000000..a140fe3e
--- /dev/null
+++ b/regress/mdoc/Cm/tag.out_html
@@ -0,0 +1,9 @@
+<dl class="Bl-tag">
+  <dt><a class="permalink" href="#one"><code class="Cm" id="one">one</code></a>
+    |
+    <a class="permalink" href="#two"><code class="Cm" id="two">two</code></a></dt>
+  <dd>text</dd>
+  <dt><a class="permalink" href="#three"><code class="Cm" id="three">three</code></a></dt>
+  <dd>text</dd>
+</dl>
+<a class="permalink" href="#four"><code class="Cm" id="four">four</code></a>
diff --git a/regress/mdoc/Cm/tag.out_markdown b/regress/mdoc/Cm/tag.out_markdown
new file mode 100644
index 00000000..893a8fe5
--- /dev/null
+++ b/regress/mdoc/Cm/tag.out_markdown
@@ -0,0 +1,23 @@
+CM-TAG(1) - General Commands Manual
+
+# NAME
+
+**Cm-tag** - tagging of command modifier macros
+
+# DESCRIPTION
+
+BEGINTEST
+
+**one** | **two**
+
+> text
+
+**three**
+
+> text
+
+**four**
+
+ENDTEST
+
+OpenBSD - March 13, 2020
diff --git a/regress/mdoc/Cm/tag.out_tag b/regress/mdoc/Cm/tag.out_tag
new file mode 100644
index 00000000..94f0cfb2
--- /dev/null
+++ b/regress/mdoc/Cm/tag.out_tag
@@ -0,0 +1,4 @@
+one 9
+two 9
+three 12
+four 13
-- 
cgit v1.2.3-56-ge451