fix: missing dependent array bounds in the output

This fixes the rendering of e.g.:

template<typename T, std::size_t N>
void
f(T(&)[N]);

which was previously rendered without the bound `N` in all the output
formats. For Adoc and HTML, the fix is just to fall back to the written
expression when the numeric value is absent. For XML, the fix is adding
ExprInfo handling in writeElement, *and* this adds several missing
elements in the XML output (e.g. initializers and requires clauses), not
just array bounds.

Author: gennaroprota

share/mrdocs/addons/generator/common/partials/type/declarator-suffix.hbs

@@ -23,7 +23,7 @@
     {{~>type/declarator-suffix pointeeType link-components-impl=link-components-impl~}}
 {{else if (eq kind "array")~}}
     {{! Array declarator suffix includes bounds and array element suffix ~}}
-    [{{boundsValue}}]
+    [{{or boundsValue boundsExpr}}]
     {{~>type/declarator-suffix elementType link-components-impl=link-components-impl~}}
 {{else if (eq kind "function")~}}
     {{! Function declarator suffix includes parameter types and cv-qualifiers ~}}

src/lib/Gen/xml/XMLWriter.cpp

@@ -13,6 +13,7 @@
 //
 
 #include "XMLWriter.hpp"
+#include <mrdocs/Metadata/Expression.hpp>
 #include <mrdocs/Metadata/Type.hpp>
 #include <mrdocs/Metadata/Template.hpp>
 #include <mrdocs/Metadata/DocComment.hpp>
@@ -177,9 +178,18 @@ XMLWriter::writeElement(std::string_view tag, T const& value)
         { if (!value) return; }
     else if constexpr (is_vector<Type>::value)
         { if (value.empty()) return; }
+    else if constexpr (std::is_base_of_v<ExprInfo, Type>)
+        { if (value.Written.empty()) return; }
 
     // Primitives inline, compounds wrapped.
-    if constexpr (std::is_same_v<Type, bool> ||
+    if constexpr (std::is_base_of_v<ExprInfo, Type>)
+    {
+        // ExprInfo and ConstantExprInfo: write the Written string.
+        tags_.indent() << "<" << tag << ">";
+        os_ << xmlEscape(value.Written);
+        os_ << "</" << tag << ">\n";
+    }
+    else if constexpr (std::is_same_v<Type, bool> ||
                   std::is_same_v<Type, std::string> ||
                   std::is_same_v<Type, dom::String> ||
                   std::is_integral_v<Type> ||

test-files/golden-tests/config/auto-function-objects/no-auto-function-objects.xml

@@ -252,6 +252,7 @@
       <identifier>auto_fn</identifier>
     </name>
   </named>
+  <initializer>{}</initializer>
   <is-constexpr>1</is-constexpr>
 </variable>
 </mrdocs>

test-files/golden-tests/config/sfinae/alias.xml

@@ -29,6 +29,7 @@
   <extraction>regular</extraction>
   <parent>//////////////////////////8=</parent>
   <named>
+    <constraints>C</constraints>
     <name>
       <kind>identifier</kind>
       <identifier>T</identifier>
@@ -68,6 +69,7 @@
   <extraction>regular</extraction>
   <parent>//////////////////////////8=</parent>
   <named>
+    <constraints>C</constraints>
     <name>
       <kind>identifier</kind>
       <identifier>T</identifier>
@@ -107,6 +109,7 @@
   <extraction>regular</extraction>
   <parent>//////////////////////////8=</parent>
   <named>
+    <constraints>std::is_class_v&lt;T&gt;</constraints>
     <name>
       <kind>identifier</kind>
       <identifier>T</identifier>
@@ -120,6 +123,7 @@
     </type-tparam>
   </template>
   <func-class>normal</func-class>
+  <requires>std::is_class_v&lt;T&gt;</requires>
 </function>
 <function>
   <name>f2</name>
@@ -136,6 +140,7 @@
   <extraction>regular</extraction>
   <parent>//////////////////////////8=</parent>
   <named>
+    <constraints>std::is_class_v&lt;T&gt;</constraints>
     <name>
       <kind>identifier</kind>
       <identifier>T</identifier>
@@ -149,5 +154,6 @@
     </type-tparam>
   </template>
   <func-class>normal</func-class>
+  <requires>std::is_class_v&lt;T&gt;</requires>
 </function>
 </mrdocs>

test-files/golden-tests/config/sfinae/redeclare.xml

@@ -45,6 +45,7 @@
   </named>
   <param>
     <named>
+      <constraints>std::is_class_v&lt;T&gt;</constraints>
       <name>
         <kind>identifier</kind>
         <identifier>void</identifier>
@@ -59,5 +60,6 @@
     </type-tparam>
   </template>
   <func-class>normal</func-class>
+  <requires>std::is_class_v&lt;T&gt;</requires>
 </function>
 </mrdocs>

test-files/golden-tests/config/sfinae/return-based.xml

@@ -26,6 +26,7 @@
   <extraction>regular</extraction>
   <parent>//////////////////////////8=</parent>
   <named>
+    <constraints>std::is_class_v&lt;T&gt;</constraints>
     <name>
       <kind>identifier</kind>
       <identifier>int</identifier>
@@ -39,5 +40,6 @@
     </type-tparam>
   </template>
   <func-class>normal</func-class>
+  <requires>std::is_class_v&lt;T&gt;</requires>
 </function>
 </mrdocs>

test-files/golden-tests/core/libcxx.xml

@@ -77,6 +77,7 @@
     </throws>
   </doc-comment>
   <named>
+    <constraints>std::is_integral_v&lt;T&gt;</constraints>
     <name>
       <kind>identifier</kind>
       <identifier>T</identifier>
@@ -99,5 +100,6 @@
     </type-tparam>
   </template>
   <func-class>normal</func-class>
+  <requires>std::is_integral_v&lt;T&gt;</requires>
 </function>
 </mrdocs>

test-files/golden-tests/filters/symbol-name/impl-defined-member.xml

@@ -124,6 +124,7 @@
       </name>
     </name>
   </named>
+  <initializer>{}</initializer>
   <is-constexpr>1</is-constexpr>
 </variable>
 <variable>
@@ -152,6 +153,7 @@
       </name>
     </name>
   </named>
+  <initializer>{}</initializer>
   <is-constexpr>1</is-constexpr>
 </variable>
 </mrdocs>

test-files/golden-tests/filters/symbol-type/nested-private-template.xml

@@ -116,6 +116,7 @@
     </type-targ>
     <constant-targ>
       <kind>constant</kind>
+      <value>false</value>
     </constant-targ>
     <primary>7XlFKPcXRfyYPWc4WPN3PAH+m58=</primary>
   </template>

test-files/golden-tests/javadoc/copydoc/param-types.xml

@@ -1863,6 +1863,7 @@
   </param>
   <param>
     <decltype>
+      <operand>a</operand>
     </decltype>
     <name>b</name>
   </param>