Various fixes to better support 6 levels of sections

doxygen · doxygen · commit 62d9e0fa62f0 · 2024-03-16T12:14:51.000+01:00
diff --git a/src/commentcnv.l b/src/commentcnv.l
@@ -44,6 +44,7 @@ typedef yyguts_t *yyscan_t;
 #include "fileinfo.h"
 #include "stringutil.h"
 #include "regex.h"
+#include "section.h"
 
 #include <assert.h>
 
@@ -1303,13 +1304,12 @@ static void parseIncludeOptions(yyscan_t yyscanner,std::string_view s)
   reg::Match match;
   if (reg::search(s,match,re))
   {
-    const int maxLevel = 6;
     yyextra->raiseIncrement = atoi(match[1].str().c_str());
-    if (yyextra->raiseLevel+yyextra->raiseIncrement>maxLevel) // check range
+    if (yyextra->raiseLevel+yyextra->raiseIncrement>=Section::MaxLevel) // check range
     {
-      warn(yyextra->fileName,yyextra->lineNr,"Raising section level from %d to %d, exceeds allowed range [0-5], adjusting",
-                yyextra->raiseLevel,yyextra->raiseLevel+yyextra->raiseIncrement);
-      yyextra->raiseIncrement = std::max(0,maxLevel-yyextra->raiseLevel);
+      warn(yyextra->fileName,yyextra->lineNr,"Raising section level from %d to %d, exceeds allowed range [0-%d], adjusting",
+                yyextra->raiseLevel,yyextra->raiseLevel+yyextra->raiseIncrement,Section::MaxLevel-1);
+      yyextra->raiseIncrement = std::max(0,Section::MaxLevel-1-yyextra->raiseLevel);
     }
   }
 }
diff --git a/src/commentscan.l b/src/commentscan.l
@@ -2430,6 +2430,20 @@ STopt  [^\n@\\]*
                                             BEGIN(Comment);
                                           }
                                         }
+<SkipInternal>[@\\]/"subparagraph"[ \t] {
+                                          if (yyextra->sectionLevel>4)
+                                          {
+                                            unput('\\');
+                                            BEGIN(Comment);
+                                          }
+                                        }
+<SkipInternal>[@\\]/"subsubparagraph"[ \t] {
+                                          if (yyextra->sectionLevel>5)
+                                          {
+                                            unput('\\');
+                                            BEGIN(Comment);
+                                          }
+                                        }
 <SkipInternal>[@\\]"endinternal"[ \t]*  {
                                           BEGIN(Comment);
                                         }
@@ -3188,7 +3202,7 @@ static bool handleSection(yyscan_t yyscanner,const QCString &s, const StringVect
   else if (s=="subparagraph")    yyextra->sectionLevel=5;
   else if (s=="subsubparagraph") yyextra->sectionLevel=6;
   // raise it if requested
-  yyextra->sectionLevel = std::min(yyextra->sectionLevel + yyextra->raiseLevel,6);
+  yyextra->sectionLevel = std::min(yyextra->sectionLevel + yyextra->raiseLevel,Section::MaxLevel);
   // rewrite the update section level to the output
   switch (yyextra->sectionLevel)
   {
@@ -3885,7 +3899,7 @@ static bool handleToc(yyscan_t yyscanner,const QCString &, const StringVector &o
     {
       QCString opt = QCString(opt_).stripWhiteSpace().lower();
       char dum;
-      int level = 5;
+      int level = Section::MaxLevel;
       int i = opt.find(':');
       if (i>0)  // found ':' but not on position 0 what would mean just a level
       {
@@ -3896,8 +3910,7 @@ static bool handleToc(yyscan_t yyscanner,const QCString &, const StringVector &o
         }
         else
         {
-          level = (level > 5 ? 5 : level);
-          level = (level <= 0 ? 5 : level);
+          level = level<=0 ? Section::MaxLevel : std::min(level,Section::MaxLevel);
           opt = opt.left(i).stripWhiteSpace();
         }
       }
@@ -3928,8 +3941,8 @@ static bool handleToc(yyscan_t yyscanner,const QCString &, const StringVector &o
     if (yyextra->current->localToc.nothingEnabled())
     {
       // for backward compatibility
-      yyextra->current->localToc.enableHtml(5);
-      yyextra->current->localToc.enableXml(5);
+      yyextra->current->localToc.enableHtml(Section::MaxLevel);
+      yyextra->current->localToc.enableXml(Section::MaxLevel);
     }
   }
   return FALSE;
diff --git a/src/doctokenizer.l b/src/doctokenizer.l
@@ -1440,6 +1440,10 @@ SHOWDATE ([0-9]{4}"-"[0-9]{1,2}"-"[0-9]{1,2})?({WS}*[0-9]{1,2}":"[0-9]{1,2}(":"[
                                       yyextra->secType = SectionType::Subparagraph;
                                       BEGIN(St_SecLabel2);
                                     }
+<St_Sections>{CMD}"subsubparagraph"{BLANK}+ {
+                                      yyextra->secType = SectionType::Subsubparagraph;
+                                      BEGIN(St_SecLabel2);
+                                    }
 <St_Sections>{CMD}"verbatim"/[^a-z_A-Z0-9]  {
                                       yyextra->endMarker="endverbatim";
                                       BEGIN(St_SecSkip);
diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp
@@ -3499,10 +3499,11 @@ void HtmlGenerator::writeLocalToc(const SectionRefs &sectionRefs,const LocalToc
     BoolVector inLi(maxLevel+1,false);
     for (const SectionInfo *si : sectionRefs)
     {
+      //printf("Section: label=%s type=%d isSection()=%d\n",qPrint(si->label()),si->type(),isSection(si->type()));
       SectionType type = si->type();
       if (isSection(type))
       {
-        //printf("  level=%d title=%s\n",level,qPrint(si->title));
+        //printf("  level=%d title=%s maxLevel=%d\n",level,qPrint(si->title()),maxLevel);
         int nextLevel = static_cast<int>(type);
         if (nextLevel>level)
         {
diff --git a/src/markdown.cpp b/src/markdown.cpp
@@ -1445,7 +1445,7 @@ int Markdown::Private::processLink(const std::string_view data,size_t offset)
   if (isToc) // special case for [TOC]
   {
     int toc_level = Config_getInt(TOC_INCLUDE_HEADINGS);
-    if (toc_level>0 && toc_level<=5)
+    if (toc_level>0 && toc_level<=Section::MaxLevel)
     {
       out+="@tableofcontents{html:";
       out+=QCString().setNum(toc_level);
diff --git a/src/rtfdocvisitor.cpp b/src/rtfdocvisitor.cpp
@@ -1147,9 +1147,7 @@ void RTFDocVisitor::operator()(const DocHtmlHeader &header)
   m_t << "{" // start section
       << rtf_Style_Reset;
   QCString heading;
-  int level = std::min(header.level()+m_hierarchyLevel,5);
-  if (level <= 0)
-    level = 1;
+  int level = std::clamp(header.level()+m_hierarchyLevel,1,Section::MaxLevel);
   heading.sprintf("Heading%d",level);
   // set style
   m_t << rtf_Style[heading.str()].reference();
diff --git a/src/rtfstyle.cpp b/src/rtfstyle.cpp
@@ -104,9 +104,13 @@ Rtf_Style_Default rtf_Style_Default[] =
     "\\sbasedon0 \\snext0 heading 4;}{\\*\\cs10 \\additive Default Paragraph Font"
   },
   { "Heading5",
-    "\\s5\\sb90\\sa30\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid ",
+    "\\s5\\sb90\\sa30\\keepn\\widctlpar\\adjustright \\b\\f1\\fs16\\cgrid ",
     "\\sbasedon0 \\snext0 heading 5;}{\\*\\cs10 \\additive Default Paragraph Font"
   },
+  { "Heading6",
+    "\\s5\\sb90\\sa30\\keepn\\widctlpar\\adjustright \\b\\f1\\fs12\\cgrid ",
+    "\\sbasedon0 \\snext0 heading 6;}{\\*\\cs10 \\additive Default Paragraph Font"
+  },
   { "Title",
     "\\s15\\qc\\sb240\\sa60\\widctlpar\\outlinelevel0\\adjustright \\b\\f1\\fs32\\kerning28\\cgrid ",
     "\\sbasedon0 \\snext15 Title"
diff --git a/src/section.h b/src/section.h
@@ -24,6 +24,11 @@
 
 class Definition;
 
+namespace Section
+{
+  const int MaxLevel = 6;
+}
+
 //! enum representing the various types of sections and entities that can be referred to.
 enum class SectionType
 {
@@ -33,7 +38,7 @@ enum class SectionType
   Subsubsection   = 3,
   Paragraph       = 4,
   Subparagraph    = 5,
-  Subsubparagraph = 6,
+  Subsubparagraph = Section::MaxLevel, // =6
   Anchor          = 7,
   Table           = 8
 };
diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp
@@ -2008,8 +2008,8 @@ static void generateXMLForPage(PageDef *pd,TextStream &ti,bool isExample)
   {
     t << "    <tableofcontents>\n";
     int level=1,l;
-    bool inLi[5]={ FALSE, FALSE, FALSE, FALSE, FALSE };
     int maxLevel = pd->localToc().xmlLevel();
+    BoolVector inLi(maxLevel+1,false);
     for (const SectionInfo *si : sectionRefs)
     {
       if (isSection(si->type()))
@@ -2028,7 +2028,7 @@ static void generateXMLForPage(PageDef *pd,TextStream &ti,bool isExample)
           for (l=level;l>nextLevel;l--)
           {
             if (l <= maxLevel && inLi[l]) t << "    </tocsect>\n";
-            inLi[l]=FALSE;
+            inLi[l]=false;
             if (l <= maxLevel) t << "    </tableofcontents>\n";
           }
         }
@@ -2041,20 +2041,20 @@ static void generateXMLForPage(PageDef *pd,TextStream &ti,bool isExample)
           t << "      <tocsect>\n";
           t << "        <name>" << titleDoc << "</name>\n";
           t << "        <reference>"  <<  convertToXML(pageName) << "_1" << label << "</reference>\n";
-          inLi[nextLevel]=TRUE;
+          inLi[nextLevel]=true;
           level = nextLevel;
         }
       }
     }
     while (level>1 && level <= maxLevel)
     {
       if (inLi[level]) t << "    </tocsect>\n";
-      inLi[level]=FALSE;
+      inLi[level]=false;
       t << "    </tableofcontents>\n";
       level--;
     }
     if (level <= maxLevel && inLi[level]) t << "    </tocsect>\n";
-    inLi[level]=FALSE;
+    inLi[level]=false;
     t << "    </tableofcontents>\n";
   }
   t << "    <briefdescription>\n";

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ typedef yyguts_t *yyscan_t;`
`44`	`44`	`#include "fileinfo.h"`
`45`	`45`	`#include "stringutil.h"`
`46`	`46`	`#include "regex.h"`
	`47`	`+#include "section.h"`
`47`	`48`
`48`	`49`	`#include <assert.h>`
`49`	`50`
`@@ -1303,13 +1304,12 @@ static void parseIncludeOptions(yyscan_t yyscanner,std::string_view s)`
`1303`	`1304`	`reg::Match match;`
`1304`	`1305`	`if (reg::search(s,match,re))`
`1305`	`1306`	`{`
`1306`		`- const int maxLevel = 6;`
`1307`	`1307`	`yyextra->raiseIncrement = atoi(match[1].str().c_str());`
`1308`		`- if (yyextra->raiseLevel+yyextra->raiseIncrement>maxLevel) // check range`
	`1308`	`+ if (yyextra->raiseLevel+yyextra->raiseIncrement>=Section::MaxLevel) // check range`
`1309`	`1309`	`{`
`1310`		`- warn(yyextra->fileName,yyextra->lineNr,"Raising section level from %d to %d, exceeds allowed range [0-5], adjusting",`
`1311`		`- yyextra->raiseLevel,yyextra->raiseLevel+yyextra->raiseIncrement);`
`1312`		`- yyextra->raiseIncrement = std::max(0,maxLevel-yyextra->raiseLevel);`
	`1310`	`+ warn(yyextra->fileName,yyextra->lineNr,"Raising section level from %d to %d, exceeds allowed range [0-%d], adjusting",`
	`1311`	`+ yyextra->raiseLevel,yyextra->raiseLevel+yyextra->raiseIncrement,Section::MaxLevel-1);`
	`1312`	`+ yyextra->raiseIncrement = std::max(0,Section::MaxLevel-1-yyextra->raiseLevel);`
`1313`	`1313`	`}`
`1314`	`1314`	`}`
`1315`	`1315`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2430,6 +2430,20 @@ STopt [^\n@\\]*`
`2430`	`2430`	`BEGIN(Comment);`
`2431`	`2431`	`}`
`2432`	`2432`	`}`
	`2433`	`+<SkipInternal>[@\\]/"subparagraph"[ \t] {`
	`2434`	`+ if (yyextra->sectionLevel>4)`
	`2435`	`+ {`
	`2436`	`+ unput('\\');`
	`2437`	`+ BEGIN(Comment);`
	`2438`	`+ }`
	`2439`	`+ }`
	`2440`	`+<SkipInternal>[@\\]/"subsubparagraph"[ \t] {`
	`2441`	`+ if (yyextra->sectionLevel>5)`
	`2442`	`+ {`
	`2443`	`+ unput('\\');`
	`2444`	`+ BEGIN(Comment);`
	`2445`	`+ }`
	`2446`	`+ }`
`2433`	`2447`	`<SkipInternal>[@\\]"endinternal"[ \t]* {`
`2434`	`2448`	`BEGIN(Comment);`
`2435`	`2449`	`}`
`@@ -3188,7 +3202,7 @@ static bool handleSection(yyscan_t yyscanner,const QCString &s, const StringVect`
`3188`	`3202`	`else if (s=="subparagraph") yyextra->sectionLevel=5;`
`3189`	`3203`	`else if (s=="subsubparagraph") yyextra->sectionLevel=6;`
`3190`	`3204`	`// raise it if requested`
`3191`		`- yyextra->sectionLevel = std::min(yyextra->sectionLevel + yyextra->raiseLevel,6);`
	`3205`	`+ yyextra->sectionLevel = std::min(yyextra->sectionLevel + yyextra->raiseLevel,Section::MaxLevel);`
`3192`	`3206`	`// rewrite the update section level to the output`
`3193`	`3207`	`switch (yyextra->sectionLevel)`
`3194`	`3208`	`{`
`@@ -3885,7 +3899,7 @@ static bool handleToc(yyscan_t yyscanner,const QCString &, const StringVector &o`
`3885`	`3899`	`{`
`3886`	`3900`	`QCString opt = QCString(opt_).stripWhiteSpace().lower();`
`3887`	`3901`	`char dum;`
`3888`		`- int level = 5;`
	`3902`	`+ int level = Section::MaxLevel;`
`3889`	`3903`	`int i = opt.find(':');`
`3890`	`3904`	`if (i>0) // found ':' but not on position 0 what would mean just a level`
`3891`	`3905`	`{`
`@@ -3896,8 +3910,7 @@ static bool handleToc(yyscan_t yyscanner,const QCString &, const StringVector &o`
`3896`	`3910`	`}`
`3897`	`3911`	`else`
`3898`	`3912`	`{`
`3899`		`- level = (level > 5 ? 5 : level);`
`3900`		`- level = (level <= 0 ? 5 : level);`
	`3913`	`+ level = level<=0 ? Section::MaxLevel : std::min(level,Section::MaxLevel);`
`3901`	`3914`	`opt = opt.left(i).stripWhiteSpace();`
`3902`	`3915`	`}`
`3903`	`3916`	`}`
`@@ -3928,8 +3941,8 @@ static bool handleToc(yyscan_t yyscanner,const QCString &, const StringVector &o`
`3928`	`3941`	`if (yyextra->current->localToc.nothingEnabled())`
`3929`	`3942`	`{`
`3930`	`3943`	`// for backward compatibility`
`3931`		`- yyextra->current->localToc.enableHtml(5);`
`3932`		`- yyextra->current->localToc.enableXml(5);`
	`3944`	`+ yyextra->current->localToc.enableHtml(Section::MaxLevel);`
	`3945`	`+ yyextra->current->localToc.enableXml(Section::MaxLevel);`
`3933`	`3946`	`}`
`3934`	`3947`	`}`
`3935`	`3948`	`return FALSE;`
Original file line number	Diff line number	Diff line change
`@@ -3499,10 +3499,11 @@ void HtmlGenerator::writeLocalToc(const SectionRefs &sectionRefs,const LocalToc`
`3499`	`3499`	`BoolVector inLi(maxLevel+1,false);`
`3500`	`3500`	`for (const SectionInfo *si : sectionRefs)`
`3501`	`3501`	`{`
	`3502`	`+ //printf("Section: label=%s type=%d isSection()=%d\n",qPrint(si->label()),si->type(),isSection(si->type()));`
`3502`	`3503`	`SectionType type = si->type();`
`3503`	`3504`	`if (isSection(type))`
`3504`	`3505`	`{`
`3505`		`- //printf(" level=%d title=%s\n",level,qPrint(si->title));`
	`3506`	`+ //printf(" level=%d title=%s maxLevel=%d\n",level,qPrint(si->title()),maxLevel);`
`3506`	`3507`	`int nextLevel = static_cast<int>(type);`
`3507`	`3508`	`if (nextLevel>level)`
`3508`	`3509`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1445,7 +1445,7 @@ int Markdown::Private::processLink(const std::string_view data,size_t offset)`
`1445`	`1445`	`if (isToc) // special case for [TOC]`
`1446`	`1446`	`{`
`1447`	`1447`	`int toc_level = Config_getInt(TOC_INCLUDE_HEADINGS);`
`1448`		`- if (toc_level>0 && toc_level<=5)`
	`1448`	`+ if (toc_level>0 && toc_level<=Section::MaxLevel)`
`1449`	`1449`	`{`
`1450`	`1450`	`out+="@tableofcontents{html:";`
`1451`	`1451`	`out+=QCString().setNum(toc_level);`
Original file line number	Diff line number	Diff line change
`@@ -2008,8 +2008,8 @@ static void generateXMLForPage(PageDef *pd,TextStream &ti,bool isExample)`
`2008`	`2008`	`{`
`2009`	`2009`	`t << " <tableofcontents>\n";`
`2010`	`2010`	`int level=1,l;`
`2011`		`- bool inLi[5]={ FALSE, FALSE, FALSE, FALSE, FALSE };`
`2012`	`2011`	`int maxLevel = pd->localToc().xmlLevel();`
	`2012`	`+ BoolVector inLi(maxLevel+1,false);`
`2013`	`2013`	`for (const SectionInfo *si : sectionRefs)`
`2014`	`2014`	`{`
`2015`	`2015`	`if (isSection(si->type()))`
`@@ -2028,7 +2028,7 @@ static void generateXMLForPage(PageDef *pd,TextStream &ti,bool isExample)`
`2028`	`2028`	`for (l=level;l>nextLevel;l--)`
`2029`	`2029`	`{`
`2030`	`2030`	`if (l <= maxLevel && inLi[l]) t << " </tocsect>\n";`
`2031`		`- inLi[l]=FALSE;`
	`2031`	`+ inLi[l]=false;`
`2032`	`2032`	`if (l <= maxLevel) t << " </tableofcontents>\n";`
`2033`	`2033`	`}`
`2034`	`2034`	`}`
`@@ -2041,20 +2041,20 @@ static void generateXMLForPage(PageDef *pd,TextStream &ti,bool isExample)`
`2041`	`2041`	`t << " <tocsect>\n";`
`2042`	`2042`	`t << " <name>" << titleDoc << "</name>\n";`
`2043`	`2043`	`t << " <reference>" << convertToXML(pageName) << "_1" << label << "</reference>\n";`
`2044`		`- inLi[nextLevel]=TRUE;`
	`2044`	`+ inLi[nextLevel]=true;`
`2045`	`2045`	`level = nextLevel;`
`2046`	`2046`	`}`
`2047`	`2047`	`}`
`2048`	`2048`	`}`
`2049`	`2049`	`while (level>1 && level <= maxLevel)`
`2050`	`2050`	`{`
`2051`	`2051`	`if (inLi[level]) t << " </tocsect>\n";`
`2052`		`- inLi[level]=FALSE;`
	`2052`	`+ inLi[level]=false;`
`2053`	`2053`	`t << " </tableofcontents>\n";`
`2054`	`2054`	`level--;`
`2055`	`2055`	`}`
`2056`	`2056`	`if (level <= maxLevel && inLi[level]) t << " </tocsect>\n";`
`2057`		`- inLi[level]=FALSE;`
	`2057`	`+ inLi[level]=false;`
`2058`	`2058`	`t << " </tableofcontents>\n";`
`2059`	`2059`	`}`
`2060`	`2060`	`t << " <briefdescription>\n";`