Fix GH-80: Trim whitespace in tag content before link resolution

phpdotnet/phd/Package/PEAR/XHTML.php

@@ -918,6 +918,7 @@ public function format_refname_text($value, $tag)
 
     public function format_function_text($value)
     {
+        $value = trim($value);
         return $this->TEXT($value.'()');
     }
 

phpdotnet/phd/Package/PHP/XHTML.php

@@ -525,6 +525,7 @@ public function format_fieldsynopsis_varname($open, $name, $attrs) {
     }
 
     public function format_varname_text($value, $tag) {
+        $value = trim($value);
         $var = $value;
         if (($pos = strpos($value, "[")) !== false) {
             $var = substr($value, 0, $pos);
@@ -678,6 +679,7 @@ public function format_type_methodparam_text($type, $tagname) {
     }
 
     public function format_type_text($type, $tagname) {
+        $type = trim($type);
         $t = strtr($this->normalizeFQN($type), ["_" => "-", "\\" => "-"]);
 
         switch($t) {
@@ -805,6 +807,7 @@ public function format_acronym_text($value, $tag) {
     }
 
     public function format_classsynopsis_fieldsynopsis_varname_text($value, $tag) {
+        $value = trim($value);
         if ($this->cchunk["classsynopsis"]["classname"]) {
           if (strpos($value, "::") === false && strpos($value, "->") === false) {
                 $value = $this->cchunk["classsynopsis"]["classname"] . "->" . $value;
@@ -815,6 +818,7 @@ public function format_classsynopsis_fieldsynopsis_varname_text($value, $tag) {
         return $this->format_varname_text($display_value, $tag);
     }
     public function format_classsynopsis_methodsynopsis_methodname_text($value, $tag) {
+        $value = trim($value);
         if ($this->cchunk["classsynopsis"]["classname"]) {
           if (strpos($value, "::") === false && strpos($value, "->") === false) {
                 $value = $this->cchunk["classsynopsis"]["classname"] . "::" . $value;
@@ -845,6 +849,8 @@ public function format_function_text($value, $tag, $display_value = null) {
             return $this->TEXT($value);
         }
 
+        $value = trim($value);
+
         static $non_functions = array(
             "echo" => true, "print" => true,
             "include" => true, "include_once" => true,
@@ -907,6 +913,7 @@ public function format_classsynopsis_oo_name_text($value, $tag) {
     }
 
     public function format_classname_text($value, $tag) {
+        $value = trim($value);
         if (($filename = $this->getClassnameLink($this->normalizeFQN($value))) !== null && $this->cchunk["class_name_ref"] !== strtolower($value)) {
             $href = $this->chunked ? $filename.$this->ext : "#$filename";
             return '<a href="'.$href. '" class="' .$tag. '">' .$value. '</a>';
@@ -915,6 +922,7 @@ public function format_classname_text($value, $tag) {
     }
 
     public function format_enumidentifier_text($value, $tag) {
+        $value = trim($value);
         if (!str_contains($value, '::')) {
             return $value;
         }

tests/package/php/data/whitespace_in_tags_link_rendering.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter xml:id="whitespace_in_tags_link_rendering" xmlns="http://docbook.org/ns/docbook">
+
+ <section>
+  <para>1. Function with leading/trailing whitespace</para>
+  <para>
+   <function>
+    strlen
+   </function>
+  </para>
+ </section>
+
+ <section>
+  <para>2. Methodname with leading/trailing whitespace</para>
+  <para>
+   <methodname>
+    Extension\Namespace\Classname::existingMethodName
+   </methodname>
+  </para>
+ </section>
+
+ <section>
+  <para>3. Classname with leading/trailing whitespace</para>
+  <para>
+   <classname>
+    Extension\Namespace\Existing_Class
+   </classname>
+  </para>
+ </section>
+
+ <section>
+  <para>4. Varname with leading/trailing whitespace</para>
+  <para>
+   <varname>
+    _SERVER
+   </varname>
+  </para>
+ </section>
+
+</chapter>

tests/package/php/whitespace_in_tags_link_rendering.phpt

@@ -0,0 +1,91 @@
+--TEST--
+GH-80 Whitespace in function/method/class tags should not break link resolution
+--FILE--
+<?php
+namespace phpdotnet\phd;
+
+require_once __DIR__ . "/../../setup.php";
+
+$config->xmlFile = __DIR__ . "/data/whitespace_in_tags_link_rendering.xml";
+
+$indices = [
+    [
+        "docbook_id" => "function.strlen",
+        "filename"   => "function.strlen",
+    ],
+    [
+        "docbook_id" => "class.extension-namespace-existing-class",
+        "filename"   => "extensionname.classpage",
+        "element"    => "phpdoc:classref",
+    ],
+    [
+        "docbook_id" => "extension-namespace-classname.existingmethodname",
+        "filename"   => "extension-namespace-classname.methodpage",
+    ],
+    [
+        "docbook_id" => "reserved.variables.server",
+        "filename"   => "reserved.variables.server",
+    ],
+];
+
+$format = new TestPHPChunkedXHTML($config, $outputHandler);
+
+foreach ($indices as $index) {
+    $format->SQLiteIndex(
+        null, // $context,
+        null, // $index,
+        $index["docbook_id"] ?? "", // $id,
+        $index["filename"] ?? "", // $filename,
+        $index["parent_id"] ?? "", // $parent,
+        $index["sdesc"] ?? "", // $sdesc,
+        $index["ldesc"] ?? "", // $ldesc,
+        $index["element"] ?? "", // $element,
+        $index["previous"] ?? "", // $previous,
+        $index["next"] ?? "", // $next,
+        $index["chunk"] ?? 0, // $chunk
+    );
+}
+
+$format->addRefname("function.strlen", "strlen");
+$format->addClassname("class.extension-namespace-existing-class", "extension\\namespace\\existing_class");
+$format->addRefname("extension-namespace-classname.methodpage", "extension\\namespace\\classname::existingmethodname");
+$format->addVarname("reserved.variables.server", "_SERVER");
+
+$render = new TestRender(new Reader($outputHandler), $config, $format);
+
+$render->run();
+?>
+--EXPECTF--
+Filename: whitespace_in_tags_link_rendering.html
+Content:
+<div id="whitespace_in_tags_link_rendering" class="chapter">
+
+ <div class="section">
+  <p class="para">1. Function with leading/trailing whitespace</p>
+  <p class="para">
+   <span class="function"><a href="function.strlen.html" class="function">strlen()</a></span>
+  </p>
+ </div>
+
+ <div class="section">
+  <p class="para">2. Methodname with leading/trailing whitespace</p>
+  <p class="para">
+   <span class="methodname"><a href="extension-namespace-classname.methodpage.html" class="methodname">Extension\Namespace\Classname::existingMethodName()</a></span>
+  </p>
+ </div>
+
+ <div class="section">
+  <p class="para">3. Classname with leading/trailing whitespace</p>
+  <p class="para">
+   <span class="classname"><a href="class.extension-namespace-existing-class.html" class="classname">Extension\Namespace\Existing_Class</a></span>
+  </p>
+ </div>
+
+ <div class="section">
+  <p class="para">4. Varname with leading/trailing whitespace</p>
+  <p class="para">
+   <var class="varname"><a href="reserved.variables.server.html" class="classname">_SERVER</a></var>
+  </p>
+ </div>
+
+</div>