Make multi-line macro definitions foldable

doxygen · Aug 2, 2023 · ea305c6 · ea305c6
1 parent ee4b4a8
commit ea305c6
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 10 deletions.
diff --git a/src/code.l b/src/code.l
@@ -2408,9 +2408,30 @@ static void codeFolding(yyscan_t yyscanner,const Definition *d)
           (yyextra->foldStack.empty() || yyextra->foldStack.back()->getEndBodyLine()!=startLine))
       {
         //printf("%d: start codeFolding for %s [%d..%d]\n",yyextra->yyLineNr,qPrint(d->name()),d->getStartDefLine(),d->getEndBodyLine());
-        bool needsSemi = d->definitionType()==Definition::TypeClass ||
-                         (d->definitionType()==Definition::TypeMember && !toMemberDef(d)->isCallable());
-        yyextra->code->startFold(yyextra->yyLineNr,"{",needsSemi ? "};" : "}");
+        if (d->definitionType()==Definition::TypeMember)
+        {
+          const MemberDef *md = toMemberDef(d);
+          if (md && md->isDefine())
+          {
+            yyextra->code->startFold(yyextra->yyLineNr,"",""); // #define X ...
+          }
+          else if (md && md->isCallable())
+          {
+            yyextra->code->startFold(yyextra->yyLineNr,"{","}"); // func() { ... }
+          }
+          else
+          {
+            yyextra->code->startFold(yyextra->yyLineNr,"{","};"); // enum X { ... }
+          }
+        }
+        else if (d->definitionType()==Definition::TypeClass)
+        {
+          yyextra->code->startFold(yyextra->yyLineNr,"{","};"); // class X { ... };
+        }
+        else
+        {
+          yyextra->code->startFold(yyextra->yyLineNr,"{","}"); // namespace X {...}
+        }
         yyextra->foldStack.push_back(d);
       }
     }

diff --git a/src/dispatcher.h b/src/dispatcher.h
@@ -73,7 +73,7 @@ struct Dispatcher<true>
 //! \tparam As   the parameter types used to invoke the method
 //! \param  v    a object of the variant type for which to invoke the method
 //! \param  args the parameters to pass to the method
-//! \note This implementation assumes a maximum of 10 types in the variant (easy to extend though by adding more cases).
+//! \note This implementation assumes a maximum of 20 types in the variant (easy to extend though by adding more cases).
 template<template<class> class W,class V, class...As>
 static constexpr void dispatch_call(V &&v,As &&... args)
 {

diff --git a/src/pre.l b/src/pre.l
@@ -1682,13 +1682,20 @@ WSopt [ \t\r]*
                                                  "expected formal parameter after # in macro definition '%s': '%s'",
                                                  qPrint(yyextra->defName),qPrint(yyextra->defLitText.stripWhiteSpace()));
                                           }
-                                          yyextra->defLitText+=yytext;
                                           if (!comment.isEmpty())
                                           {
                                             outputString(yyscanner,comment);
                                             yyextra->defLitText=yyextra->defLitText.left(yyextra->defLitText.length()-comment.length()-1);
                                           }
-                                          outputChar(yyscanner,'\n');
+                                          if (yyextra->defLitText.find('\n')!=-1)
+                                          {
+                                            outputString(yyscanner,"/*#end#*/\n");
+                                          }
+                                          else
+                                          {
+                                            outputChar(yyscanner,'\n');
+                                          }
+                                          yyextra->defLitText+=yytext;
                                           Define *def=0;
                                           //printf("Define name='%s' text='%s' litTexti='%s'\n",qPrint(yyextra->defName),qPrint(yyextra->defText),qPrint(yyextra->defLitText));
                                           if (yyextra->includeStack.empty() || yyextra->curlyCount>0)

diff --git a/src/scanner.l b/src/scanner.l
@@ -2582,7 +2582,7 @@ NONLopt [^\n]*
                                           yyextra->current->name = yytext;
                                           BEGIN(DefineEnd);
                                         }
-<DefineEnd>\n                           {
+<DefineEnd>({BN}*{B}*"/*#end#*/")?\n    {
                                           //printf("End define: doc=%s docFile=%s docLine=%d\n",qPrint(yyextra->current->doc),qPrint(yyextra->current->docFile),yyextra->current->docLine);
                                           yyextra->current->fileName   = yyextra->fileName;
                                           yyextra->current->startLine  = yyextra->yyLineNr;
@@ -2591,8 +2591,14 @@ NONLopt [^\n]*
                                           yyextra->current->args       = yyextra->current->args.simplifyWhiteSpace();
                                           yyextra->current->name       = yyextra->current->name.stripWhiteSpace();
                                           yyextra->current->section    = Entry::DEFINE_SEC;
-                                          yyextra->current_root->moveToSubEntryAndRefresh(yyextra->current);
                                           lineCount(yyscanner);
+                                          if (yyleng>1) // multiline define
+                                          {
+                                            yyextra->current->endBodyLine = yyextra->yyLineNr-1;
+                                            //printf("found multiline define %s body=[%d..%d]\n",
+                                            //    qPrint(yyextra->current->name),yyextra->current->bodyLine,yyextra->current->endBodyLine);
+                                          }
+                                          yyextra->current_root->moveToSubEntryAndRefresh(yyextra->current);
                                           initEntry(yyscanner);
                                           BEGIN(yyextra->lastDefineContext);
                                         }

diff --git a/testing/085/085__tooltip_8cpp.xml b/testing/085/085__tooltip_8cpp.xml
@@ -34,7 +34,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="085_tooltip.cpp" line="11" column="9" bodyfile="085_tooltip.cpp" bodystart="11" bodyend="-1"/>
+        <location file="085_tooltip.cpp" line="11" column="9" bodyfile="085_tooltip.cpp" bodystart="11" bodyend="15"/>
       </memberdef>
       <memberdef kind="define" id="085__tooltip_8cpp_1a11a2c0486e2bbd915f975a3517817de6" prot="public" static="no">
         <name>FCLOSE_MACRO</name>
@@ -49,7 +49,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="085_tooltip.cpp" line="18" column="9" bodyfile="085_tooltip.cpp" bodystart="18" bodyend="-1"/>
+        <location file="085_tooltip.cpp" line="18" column="9" bodyfile="085_tooltip.cpp" bodystart="18" bodyend="22"/>
       </memberdef>
     </sectiondef>
     <sectiondef kind="var">