issue #10708 Incorrect parsing to xml of c++11 constructs in methods and functions

doxygen · doxygen · commit b51d6d2dd2cb · 2024-03-23T16:53:40.000+01:00
diff --git a/src/memberdef.cpp b/src/memberdef.cpp
@@ -178,6 +178,7 @@ class MemberDefImpl : public DefinitionMixin<MemberDefMutable>
     bool isStrongEnumValue() const override;
     bool livesInsideEnum() const override;
     bool isSliceLocal() const override;
+    bool isNoDiscard() const override;
     bool isConstExpr() const override;
     bool isConstEval() const override;
     bool isConstInit() const override;
@@ -773,6 +774,8 @@ class MemberDefAliasImpl : public DefinitionAliasMixin<MemberDef>
     { return getMdAlias()->livesInsideEnum(); }
     bool isSliceLocal() const override
     { return getMdAlias()->isSliceLocal(); }
+    bool isNoDiscard() const override
+    { return getMdAlias()->isNoDiscard(); }
     bool isConstExpr() const override
     { return getMdAlias()->isConstExpr(); }
     bool isConstEval() const override
@@ -2805,6 +2808,7 @@ StringVector MemberDefImpl::getLabels(const Definition *container) const
           if    (isPrivateGettable())                   sl.push_back("private get");
           if    (isPrivateSettable())                   sl.push_back("private set");
         }
+        if      (isNoDiscard())                         sl.push_back("nodiscard");
         if      (isConstExpr())                         sl.push_back("constexpr");
         if      (isConstEval())                         sl.push_back("consteval");
         if      (isConstInit())                         sl.push_back("constinit");
@@ -3470,6 +3474,9 @@ void MemberDefImpl::writeDocumentation(const MemberList *ml,
       ldef.remove(pos, prefix.length());
     }
   }
+  ldef.stripPrefix("constexpr ");
+  ldef.stripPrefix("consteval ");
+  ldef.stripPrefix("constinit ");
 
   //----------------------------------------
 
@@ -5444,6 +5451,11 @@ bool MemberDefImpl::isSliceLocal() const
   return m_memSpec.isLocal();
 }
 
+bool MemberDefImpl::isNoDiscard() const
+{
+  return m_memSpec.isNoDiscard();
+}
+
 bool MemberDefImpl::isConstExpr() const
 {
   return m_memSpec.isConstExpr();
diff --git a/src/memberdef.h b/src/memberdef.h
@@ -190,6 +190,7 @@ class MemberDef : public Definition
     virtual bool isConstExpr() const = 0;
     virtual bool isConstEval() const = 0;
     virtual bool isConstInit() const = 0;
+    virtual bool isNoDiscard() const = 0;
     virtual int  numberOfFlowKeyWords() const = 0;
 
     // derived getters
diff --git a/src/scanner.l b/src/scanner.l
@@ -5725,6 +5725,12 @@ NONLopt [^\n]*
                                             BEGIN(SkipPHPString);
                                           }
                                         }
+<SkipC11Attribute>{ID}                  {
+                                          if (QCString(yytext)=="nodiscard")
+                                          {
+                                            yyextra->current->spec.setNoDiscard(true);
+                                          }
+                                        }
 <SkipInits,SkipC11Inits,SkipCurly,SkipCurlyCpp,SkipC11Attribute>.       { }
 <SkipString,SkipPHPString>\\.           { }
 <SkipString>\"                          {
diff --git a/src/types.h b/src/types.h
@@ -373,7 +373,8 @@ class LocalToc
 /* 45 */ TSPEC(Strong)            TSPEC(Weak)            TSPEC(Unretained)        TSPEC(Alias)        TSPEC(ConstExp)           \
 /* 50 */ TSPEC(Default)           TSPEC(Delete)          TSPEC(NoExcept)          TSPEC(Attribute)    TSPEC(Property)           \
 /* 55 */ TSPEC(Readonly)          TSPEC(Bound)           TSPEC(Constrained)       TSPEC(Transient)    TSPEC(MaybeVoid)          \
-/* 60 */ TSPEC(MaybeDefault)      TSPEC(MaybeAmbiguous)  TSPEC(Published)         TSPEC(ConstEval)    TSPEC(ConstInit)
+/* 60 */ TSPEC(MaybeDefault)      TSPEC(MaybeAmbiguous)  TSPEC(Published)         TSPEC(ConstEval)    TSPEC(ConstInit)          \
+/* 65 */ TSPEC(NoDiscard)
 
 /** Wrapper class for a number of boolean properties.
  *  The properties are packed together, and initialized to false.
diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp
@@ -531,8 +531,11 @@ static void stripQualifiers(QCString &typeStr)
   typeStr.stripPrefix("friend ");
   while (!done)
   {
-    if (typeStr.stripPrefix("static "));
-    else if (typeStr.stripPrefix("virtual "));
+    if (typeStr.stripPrefix("static "))         {}
+    else if (typeStr.stripPrefix("constexpr ")) {}
+    else if (typeStr.stripPrefix("consteval ")) {}
+    else if (typeStr.stripPrefix("constinit ")) {}
+    else if (typeStr.stripPrefix("virtual "))   {}
     else if (typeStr=="virtual") typeStr="";
     else done=TRUE;
   }
@@ -557,6 +560,49 @@ static QCString memberOutputFileBase(const MemberDef *md)
   return md->getOutputFileBase();
 }
 
+static QCString extractNoExcept(QCString &argsStr)
+{
+  QCString expr;
+  //printf("extractNoExcept(%s)\n",qPrint(argsStr));
+  int i = argsStr.find("noexcept(");
+  if (i!=-1)
+  {
+    int  bracketCount = 1;
+    size_t p = i+9;
+    bool found = false;
+    bool insideString = false;
+    bool insideChar = false;
+    char pc = 0;
+    while (!found && p<argsStr.length())
+    {
+      char c = argsStr[p++];
+      if (insideString)
+      {
+        if (c=='"' && pc!='\\') insideString=false;
+      }
+      else if (insideChar)
+      {
+        if (c=='\'' && pc!='\\') insideChar=false;
+      }
+      else
+      {
+        switch (c)
+        {
+          case '(':  bracketCount++;      break;
+          case ')':  bracketCount--;      found = bracketCount==0; break;
+          case '"':  insideString = true; break;
+          case '\'': insideChar   = true; break;
+        }
+      }
+      pc = c;
+    }
+    expr = argsStr.mid(i+9,p-i-10);
+    argsStr = (argsStr.left(i) + argsStr.mid(p)).stripWhiteSpace();
+  }
+  //printf("extractNoExcept -> argsStr='%s', expr='%s'\n",qPrint(argsStr),qPrint(expr));
+  return expr;
+}
+
 
 static void generateXMLForMember(const MemberDef *md,TextStream &ti,TextStream &t,const Definition *def)
 {
@@ -605,6 +651,30 @@ static void generateXMLForMember(const MemberDef *md,TextStream &ti,TextStream &
   }
 
   QCString nameStr = md->name();
+  QCString typeStr = md->typeString();
+  QCString argsStr = md->argsString();
+  QCString defStr = md->definition();
+  defStr.stripPrefix("constexpr ");
+  defStr.stripPrefix("consteval ");
+  defStr.stripPrefix("constinit ");
+  stripAnonymousMarkers(typeStr);
+  stripQualifiers(typeStr);
+  if (typeStr=="auto")
+  {
+    int i=argsStr.findRev("->");
+    if (i!=-1) // move trailing return type into type and strip it from argsStr
+    {
+      typeStr=argsStr.mid(i+2).stripWhiteSpace();
+      argsStr=argsStr.left(i).stripWhiteSpace();
+      i=defStr.find("auto ");
+      if (i!=-1)
+      {
+        defStr=defStr.left(i)+typeStr+defStr.mid(i+4);
+      }
+    }
+  }
+  QCString noExceptExpr = extractNoExcept(argsStr);
+
   stripAnonymousMarkers(nameStr);
   ti << "    <member refid=\"" << memberOutputFileBase(md)
      << "_1" << md->anchor() << "\" kind=\"" << memType << "\"><name>"
@@ -642,6 +712,11 @@ static void generateXMLForMember(const MemberDef *md,TextStream &ti,TextStream &
   if (md->isStatic()) t << "yes"; else t << "no";
   t << "\"";
 
+  if (md->isNoDiscard())
+  {
+    t << " nodiscard=\"yes\"";
+  }
+
   if (md->isConstExpr())
   {
     t << " constexpr=\"yes\"";
@@ -714,6 +789,11 @@ static void generateXMLForMember(const MemberDef *md,TextStream &ti,TextStream &
       t << " noexcept=\"yes\"";
     }
 
+    if (!noExceptExpr.isEmpty())
+    {
+      t << " noexceptexpression=\"" << convertToXML(noExceptExpr) << "\"";
+    }
+
     if (al.volatileSpecifier())
     {
       t << " volatile=\"yes\"";
@@ -859,20 +939,16 @@ static void generateXMLForMember(const MemberDef *md,TextStream &ti,TextStream &
      )
   {
     writeMemberTemplateLists(md,t);
-    QCString typeStr = md->typeString();
-    stripAnonymousMarkers(typeStr);
-    stripQualifiers(typeStr);
     t << "        <type>";
     linkifyText(TextGeneratorXMLImpl(t),def,md->getBodyDef(),md,typeStr);
     t << "</type>\n";
-    QCString defStr = md->definition();
     if (md->isTypeAlias())
     {
       defStr+=" = "+md->initializer();
     }
     stripAnonymousMarkers(defStr);
     t << "        <definition>" << convertToXML(defStr) << "</definition>\n";
-    t << "        <argsstring>" << convertToXML(md->argsString()) << "</argsstring>\n";
+    t << "        <argsstring>" << convertToXML(argsStr) << "</argsstring>\n";
   }
 
   if (md->memberType() == MemberType_Enumeration)
diff --git a/templates/xml/compound.xsd b/templates/xml/compound.xsd
@@ -220,6 +220,8 @@
     <xsd:attribute name="volatile" type="DoxBool" use="optional"/>
     <xsd:attribute name="mutable" type="DoxBool" use="optional"/>
     <xsd:attribute name="noexcept" type="DoxBool" use="optional"/>
+    <xsd:attribute name="noexceptexpression" type="xsd:string" use="optional"/>
+    <xsd:attribute name="nodiscard" type="DoxBool" use="optional"/>
     <xsd:attribute name="constexpr" type="DoxBool" use="optional"/>
     <xsd:attribute name="consteval" type="DoxBool" use="optional"/>
     <xsd:attribute name="constinit" type="DoxBool" use="optional"/>
diff --git a/testing/102/class_a.xml b/testing/102/class_a.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="" xml:lang="en-US">
+  <compounddef id="class_a" kind="class" language="C++" prot="public">
+    <compoundname>A</compoundname>
+    <includes refid="102__header_8hpp" local="no">102_header.hpp</includes>
+    <sectiondef kind="public-func">
+      <memberdef kind="function" id="class_a_1ac5350de77c7e927b4bafa27a899743a8" prot="public" static="no" nodiscard="yes" constexpr="yes" const="no" explicit="no" inline="yes" noexcept="yes" noexceptexpression="std::is_nothrow_move_assignable_v&lt; A &gt;" virt="non-virtual">
+        <type>int</type>
+        <definition>int A::do_stuff</definition>
+        <argsstring>()</argsstring>
+        <name>do_stuff</name>
+        <qualifiedname>A::do_stuff</qualifiedname>
+        <briefdescription>
+          <para>Does stuff. </para>
+        </briefdescription>
+        <detaileddescription>
+          <para>Details </para>
+        </detaileddescription>
+        <inbodydescription>
+        </inbodydescription>
+        <location file="102_header.hpp" line="15" column="20" bodyfile="102_header.hpp" bodystart="15" bodyend="17"/>
+      </memberdef>
+      <memberdef kind="function" id="class_a_1aa0ac26ebde08a69be4382f29077bd5d4" prot="public" static="no" nodiscard="yes" constexpr="yes" const="no" explicit="no" inline="yes" noexcept="yes" noexceptexpression="std::is_nothrow_move_assignable_v&lt; A &gt;" virt="non-virtual">
+        <type>int</type>
+        <definition>int A::do_stuff2</definition>
+        <argsstring>()</argsstring>
+        <name>do_stuff2</name>
+        <qualifiedname>A::do_stuff2</qualifiedname>
+        <briefdescription>
+          <para>Does stuff. </para>
+        </briefdescription>
+        <detaileddescription>
+          <para>Details </para>
+        </detaileddescription>
+        <inbodydescription>
+        </inbodydescription>
+        <location file="102_header.hpp" line="21" column="21" bodyfile="102_header.hpp" bodystart="21" bodyend="23"/>
+      </memberdef>
+    </sectiondef>
+    <briefdescription>
+      <para>Some class. </para>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <location file="102_header.hpp" line="10" column="1" bodyfile="102_header.hpp" bodystart="11" bodyend="24"/>
+    <listofallmembers>
+      <member refid="class_a_1ac5350de77c7e927b4bafa27a899743a8" prot="public" virt="non-virtual">
+        <scope>A</scope>
+        <name>do_stuff</name>
+      </member>
+      <member refid="class_a_1aa0ac26ebde08a69be4382f29077bd5d4" prot="public" virt="non-virtual">
+        <scope>A</scope>
+        <name>do_stuff2</name>
+      </member>
+    </listofallmembers>
+  </compounddef>
+</doxygen>
diff --git a/testing/102_header.hpp b/testing/102_header.hpp
@@ -0,0 +1,26 @@
+// objective: test noexcept with expression and nodiscard and constexpr
+// check: class_a.xml
+//
+#ifndef INCLUDE_GUARD
+#define INCLUDE_GUARD
+
+#include <type_traits>
+
+/// @brief Some class
+class A
+{
+  public:
+    /// @brief Does stuff
+    /// @details Details
+    [[nodiscard]] constexpr int do_stuff() noexcept(std::is_nothrow_move_assignable_v<A>)
+    {
+    }
+
+    /// @brief Does stuff
+    /// @details Details
+    [[nodiscard]] constexpr auto do_stuff2() noexcept(std::is_nothrow_move_assignable_v<A>) -> int
+    {
+    }
+};
+
+#endif

Original file line number	Diff line number	Diff line change
`@@ -5725,6 +5725,12 @@ NONLopt [^\n]*`
`5725`	`5725`	`BEGIN(SkipPHPString);`
`5726`	`5726`	`}`
`5727`	`5727`	`}`
	`5728`	`+<SkipC11Attribute>{ID} {`
	`5729`	`+ if (QCString(yytext)=="nodiscard")`
	`5730`	`+ {`
	`5731`	`+ yyextra->current->spec.setNoDiscard(true);`
	`5732`	`+ }`
	`5733`	`+ }`
`5728`	`5734`	`<SkipInits,SkipC11Inits,SkipCurly,SkipCurlyCpp,SkipC11Attribute>. { }`
`5729`	`5735`	`<SkipString,SkipPHPString>\\. { }`
`5730`	`5736`	`<SkipString>\" {`