PR doxygen#12243 reduce code duplication and some minor refactoring

Author: doxygen

src/docbookgen.cpp

@@ -76,7 +76,7 @@
 
 inline void writeDocbookString(TextStream &t,const QCString &s)
 {
-  t << convertToDocBook(s);
+  t << DocbookGenerator::convertToDocbook(s);
 }
 
 inline void writeDocbookCodeString(bool hide,TextStream &t,const QCString &str, size_t &col, size_t stripIndentAmount)
@@ -137,12 +137,12 @@ inline void writeDocbookCodeString(bool hide,TextStream &t,const QCString &str,
 static void addIndexTerm(TextStream &t, QCString prim, QCString sec = "")
 {
   t << "<indexterm><primary>";
-  t << convertToDocBook(prim);
+  t << DocbookGenerator::convertToDocbook(prim);
   t << "</primary>";
   if (!sec.isEmpty())
   {
     t << "<secondary>";
-    t << convertToDocBook(sec);
+    t << DocbookGenerator::convertToDocbook(sec);
     t << "</secondary>";
   }
   t << "</indexterm>\n";
@@ -456,7 +456,7 @@ DB_GEN_C2("IndexSection " << is)
       {
         QCString dbk_projectName = Config_getString(PROJECT_NAME);
         m_t << "    <info>\n";
-        m_t << "    <title>" << convertToDocBook(dbk_projectName) << "</title>\n";
+        m_t << "    <title>" << convertToDocbook(dbk_projectName) << "</title>\n";
         m_t << "    </info>\n";
       }
       break;
@@ -768,7 +768,7 @@ DB_GEN_C
 void DocbookGenerator::docify(const QCString &str)
 {
 DB_GEN_C
-  m_t << convertToDocBook(str);
+  m_t << convertToDocbook(str);
 }
 static QCString objectLinkToString(const QCString &, const QCString &f,
                                    const QCString &anchor, const QCString &text)
@@ -784,7 +784,7 @@ DB_GEN_C
   {
     result += "<link linkend=\"_" + stripPath(f) + "\">";
   }
-  result += convertToDocBook(text);
+  result += DocbookGenerator::convertToDocbook(text);
   result += "</link>";
   return result;
 }
@@ -911,7 +911,7 @@ void DocbookGenerator::startMemberDoc(const QCString &clname, const QCString &me
 {
 DB_GEN_C2("m_inLevel " << m_inLevel)
   openSection();
-  m_t << "    <title>" << convertToDocBook(title);
+  m_t << "    <title>" << convertToDocbook(title);
   if (memTotal>1)
   {
     m_t << "<computeroutput>[" << memCount << "/" << memTotal << "]</computeroutput>";
@@ -1165,7 +1165,7 @@ DB_GEN_C
     title = theTranslator->trCompoundMembers();
   }
   m_t << "<table frame=\"all\">\n";
-  if (!title.isEmpty()) m_t << "<title>" << convertToDocBook(title) << "</title>\n";
+  if (!title.isEmpty()) m_t << "<title>" << convertToDocbook(title) << "</title>\n";
   m_t << "    <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
   for (int i = 0; i < ncols; i++)
   {
@@ -1220,12 +1220,12 @@ DB_GEN_C
   m_t << "</entry></row>\n";
 }
 
-void DocbookGenerator::startDescTable(const QCString &title,const bool hasInits)
+void DocbookGenerator::startDescTable(const QCString &title,bool hasInits)
 {
 DB_GEN_C
   int ncols = (hasInits?3:2);
   m_t << "<informaltable frame=\"all\">\n";
-  if (!title.isEmpty()) m_t << "<title>" << convertToDocBook(title) << "</title>\n";
+  if (!title.isEmpty()) m_t << "<title>" << convertToDocbook(title) << "</title>\n";
   m_t << "    <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
   int i = 1;
   m_t << "      <colspec colname='c" << i++ << "'/>\n";
@@ -1411,7 +1411,7 @@ void DocbookGenerator::writeInheritedSectionTitle(
                   const QCString &title, const QCString &name)
 {
 DB_GEN_C
-  m_t << theTranslator->trInheritedFrom(convertToDocBook(title), objectLinkToString(ref, file, anchor, name));
+  m_t << theTranslator->trInheritedFrom(convertToDocbook(title), objectLinkToString(ref, file, anchor, name));
 }
 
 void DocbookGenerator::startLocalToc(int level)
@@ -1458,7 +1458,7 @@ void DocbookGenerator::startTocEntry(const SectionInfo *si)
     }
     if (nextLevel <= m_tocState.maxLevel)
     {
-      QCString label = convertToDocBook(si->label());
+      QCString label = convertToDocbook(si->label());
       m_t << "      <tocentry>";
     }
   }
@@ -1481,21 +1481,19 @@ void DocbookGenerator::endTocEntry(const SectionInfo *si)
 static constexpr auto hex="0123456789ABCDEF";
 
 /*! Converts a string to an DocBook-encoded string */
-QCString convertToDocBook(const QCString &s, const bool retainNewline, const bool /* citeEntry */)
+QCString DocbookGenerator::convertToDocbook(const QCString &s, bool retainNewline, bool /* citeEntry */)
 {
   if (s.isEmpty()) return s;
   QCString result;
   result.reserve(s.length()+32);
   const char *p = s.data();
-  const char *q = nullptr;
-  int cnt = 0;
   char c = 0;
   while ((c=*p++))
   {
     switch (c)
     {
       case '\n':
-        if (retainNewline) 
+        if (retainNewline)
         {
           result+="<literallayout>&#160;&#xa;</literallayout>";
           result+=c;
@@ -1504,33 +1502,7 @@ QCString convertToDocBook(const QCString &s, const bool retainNewline, const boo
       case '<':  result+="&lt;";   break;
       case '>':  result+="&gt;";   break;
       case '&':  // possibility to have a special symbol
-        q = p;
-        cnt = 2; // we have to count & and ; as well
-        while ((*q >= 'a' && *q <= 'z') || (*q >= 'A' && *q <= 'Z') || (*q >= '0' && *q <= '9'))
-        {
-          cnt++;
-          q++;
-        }
-        if (*q == ';')
-        {
-           --p; // we need & as well
-           HtmlEntityMapper::SymType res = HtmlEntityMapper::instance().name2sym(QCString(p).left(cnt));
-           if (res == HtmlEntityMapper::Sym_Unknown)
-           {
-             p++;
-             result+="&amp;";
-           }
-           else
-           {
-             result+=HtmlEntityMapper::instance().docbook(res);
-             q++;
-             p = q;
-           }
-        }
-        else
-        {
-          result+="&amp;";
-        }
+        p = writeHtmlEntity(result, p-1, [](HtmlEntityMapper::SymType symType) { return HtmlEntityMapper::instance().docbook(symType); }, "&amp;");
         break;
       case '\'': result+="&apos;"; break;
       case '"':  result+="&quot;"; break;

src/docbookgen.h

@@ -178,7 +178,7 @@ class DocbookGenerator final : public OutputGenerator, public OutputGenIntf
     void addIndexItem(const QCString &,const QCString &) override;
     void writeNonBreakableSpace(int) override;
 
-    void startDescTable(const QCString &title,const bool hasInits) override;
+    void startDescTable(const QCString &title,bool hasInits) override;
     void endDescTable() override;
     void startDescTableRow() override;
     void endDescTableRow() override;
@@ -322,6 +322,7 @@ class DocbookGenerator final : public OutputGenerator, public OutputGenIntf
 
     void startEmbeddedDoc(int) override {}
     void endEmbeddedDoc() override {}
+    static QCString convertToDocbook(const QCString &s, bool retainNewline = false, bool citeEntry = false);
 
 private:
     void openSection(const QCString &attr=QCString());
@@ -352,7 +353,6 @@ class DocbookGenerator final : public OutputGenerator, public OutputGenIntf
     TocState m_tocState;
 };
 
-QCString convertToDocBook(const QCString &s, const bool retainNewline = false, const bool citeEntry = false);
 
 
 #endif

src/docbookvisitor.cpp

@@ -116,15 +116,15 @@ void DocbookDocVisitor::visitPreStart(TextStream &t,
   t << "                <imagedata";
   if (!width.isEmpty())
   {
-    t << " width=\"" << convertToDocBook(width) << "\"";
+    t << " width=\"" << DocbookGenerator::convertToDocbook(width) << "\"";
   }
   else
   {
     if (!height.isEmpty() && !inlineImage) t << " width=\"50%\"";
   }
   if (!height.isEmpty())
   {
-    t << " depth=\"" << convertToDocBook(height) << "\"";
+    t << " depth=\"" << DocbookGenerator::convertToDocbook(height) << "\"";
   }
   t << " align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\"" << name << "\">";
   t << "</imagedata>\n";
@@ -671,7 +671,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trSeeAlso()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trSeeAlso()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Return:
@@ -681,7 +681,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trReturns()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trReturns()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Author:
@@ -691,7 +691,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trAuthor(TRUE, TRUE)) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trAuthor(TRUE, TRUE)) << "</title>\n";
       }
       break;
     case DocSimpleSect::Authors:
@@ -701,7 +701,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trAuthor(TRUE, FALSE)) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trAuthor(TRUE, FALSE)) << "</title>\n";
       }
       break;
     case DocSimpleSect::Version:
@@ -711,7 +711,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trVersion()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trVersion()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Since:
@@ -721,7 +721,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trSince()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trSince()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Date:
@@ -731,7 +731,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trDate()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trDate()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Note:
@@ -741,7 +741,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<note><title>" << convertToDocBook(theTranslator->trNote()) << "</title>\n";
+        m_t << "<note><title>" << DocbookGenerator::convertToDocbook(theTranslator->trNote()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Warning:
@@ -751,7 +751,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<warning><title>" << convertToDocBook(theTranslator->trWarning()) << "</title>\n";
+        m_t << "<warning><title>" << DocbookGenerator::convertToDocbook(theTranslator->trWarning()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Pre:
@@ -761,7 +761,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trPrecondition()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trPrecondition()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Post:
@@ -771,7 +771,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trPostcondition()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trPostcondition()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Copyright:
@@ -781,7 +781,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trCopyright()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trCopyright()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Invar:
@@ -791,7 +791,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trInvariant()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trInvariant()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Remark:
@@ -802,7 +802,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trRemarks()) << "</title>\n";
+        m_t << "<formalpara><title>" << DocbookGenerator::convertToDocbook(theTranslator->trRemarks()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Attention:
@@ -812,7 +812,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<caution><title>" << convertToDocBook(theTranslator->trAttention()) << "</title>\n";
+        m_t << "<caution><title>" << DocbookGenerator::convertToDocbook(theTranslator->trAttention()) << "</title>\n";
       }
       break;
     case DocSimpleSect::Important:
@@ -822,7 +822,7 @@ DB_VIS_C
       }
       else
       {
-        m_t << "<important><title>" << convertToDocBook(theTranslator->trImportant()) << "</title>\n";
+        m_t << "<important><title>" << DocbookGenerator::convertToDocbook(theTranslator->trImportant()) << "</title>\n";
       }
       break;
     case DocSimpleSect::User:
@@ -1068,7 +1068,7 @@ DB_VIS_C
     if (supportedHtmlAttribute(opt.name))
     {
       // process supported attributes only
-      m_t << " " << opt.name << "='" << convertToDocBook(opt.value) << "'";
+      m_t << " " << opt.name << "='" << DocbookGenerator::convertToDocbook(opt.value) << "'";
     }
   }
   m_t << ">\n";
@@ -1122,13 +1122,13 @@ DB_VIS_C
       }
       else
       {
-        m_t << " class='" << convertToDocBook(opt.value) << "'";
+        m_t << " class='" << DocbookGenerator::convertToDocbook(opt.value) << "'";
       }
     }
     else if (supportedHtmlAttribute(opt.name))
     {
       // process supported attributes only
-      m_t << " " << opt.name << "='" << convertToDocBook(opt.value) << "'";
+      m_t << " " << opt.name << "='" << DocbookGenerator::convertToDocbook(opt.value) << "'";
     }
   }
   m_t << ">";
@@ -1162,7 +1162,7 @@ DB_VIS_C
   if (m_hide) return;
   if (href.url().at(0) != '#')
   {
-    m_t << "<link xlink:href=\"" << convertToDocBook(href.url()) << "\">";
+    m_t << "<link xlink:href=\"" << DocbookGenerator::convertToDocbook(href.url()) << "\">";
   }
   else
   {
@@ -1533,10 +1533,10 @@ DB_VIS_C
 }
 
 
-void DocbookDocVisitor::filter(const QCString &str, const bool retainNewLine, const bool citeEntry)
+void DocbookDocVisitor::filter(const QCString &str, bool retainNewLine, bool citeEntry)
 {
 DB_VIS_C
-  m_t << convertToDocBook(str, retainNewLine, citeEntry);
+  m_t << DocbookGenerator::convertToDocbook(str, retainNewLine, citeEntry);
 }
 
 void DocbookDocVisitor::startLink(const QCString &file,const QCString &anchor)