issue doxygen#11634 Doxygen Latex Tables not working correctly

Author: doxygen

doc/Doxyfile

@@ -61,6 +61,8 @@ ALIASES          += TeX="\f({\TeX}\f)"
 ALIASES          += forceNewPage="\latexonly \newpage \endlatexonly"
 ALIASES          += startalign=" \latexonly\noalign{\endlatexonly"
 ALIASES          += endalign=" \latexonly}\endlatexonly"
+ALIASES          += startalign=
+ALIASES          += endalign=
 ALIASES          += startendhtmltag{1}="\startalign\anchor htmltag_\1 \addindex \"\<\1\>\" ^^ \anchor htmltag_end\1 \addindex \"\</\1\>\"\endalign <tt>\<\1\></tt> / <tt>\</\1\></tt>"
 LATEX_BATCHMODE   = YES
 LATEX_EXTRA_STYLESHEET = manual.sty

doc/doxygen_manual.tex

@@ -16,13 +16,6 @@
 \pdfminorversion=7
 \pdfsuppresswarningpagegroup=1
 \documentclass{book}
-%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
-\usepackage{ifthen}
-\ifx\requestedLaTeXdate\undefined
-\usepackage{array}
-\else
-\usepackage{array}[=2016-10-06]
-\fi
 %%
 \makeatletter
 % suppress package identification of infwarerr as it contains the word "warning"
@@ -41,7 +34,6 @@
 \usepackage{geometry}
 \usepackage{listings}
 \usepackage{color}
-%%\usepackage{ifthen} %% moved to top due to workaround for LaTex 2019 version and unmaintained tabu package
 \usepackage[table]{xcolor}
 \PassOptionsToPackage{warn}{textcomp}
 \usepackage{textcomp}

doc/htmlcmds.dox

@@ -368,7 +368,7 @@ The list of special HTML4 character entities with their descriptions has been ta
 | <tt>\&lsaquo;</tt> | &lsaquo; | single left-pointing angle quotation mark |
 | <tt>\&rsaquo;</tt> | &rsaquo; | single right-pointing angle quotation mark |
 | <tt>\&euro;</tt> | &euro; | euro sign |
-| **Doxygen extensions:** |||
+| **Doxygen extensions** |||
 | <tt>\&tm;</tt> | &tm; | trade mark sign |
 | <tt>\&apos;</tt> | &apos; | apostrophe|
 

src/latexdocvisitor.cpp

@@ -1256,11 +1256,11 @@ void LatexDocVisitor::writeStartTableCommand(const DocNodeVariant *n,size_t cols
 {
   if (isTableNested(n))
   {
-    m_t << "\n\\begin{DoxyTableNested}{" << cols << "}\n";
+    m_t << "\n\\begin{DoxyTableNested}{" << cols << "}";
   }
   else
   {
-    m_t << "\n\\begin{DoxyTable}{" << cols << "}\n";
+    m_t << "\n\\begin{DoxyTable}{" << cols << "}";
   }
   //return isNested ? "TabularNC" : "TabularC";
 }
@@ -1294,33 +1294,40 @@ void LatexDocVisitor::operator()(const DocHtmlTable &t)
     m_t << "\n";
   }
 
+  const DocHtmlRow *firstRow = std::get_if<DocHtmlRow>(t.firstRow());
   writeStartTableCommand(t.parent(),t.numColumns());
-
-  if (c)
+  if (!isTableNested(t.parent()))
   {
-    m_t << "\\caption{";
-    std::visit(*this, *t.caption());
+    // write caption
+    m_t << "{";
+    if (c)
+    {
+      std::visit(*this, *t.caption());
+    }
+    m_t << "}";
+    // write label
+    m_t << "{";
+    if (c)
+    {
+      m_t << stripPath(c->file()) << "_" << c->anchor();
+    }
     m_t << "}";
-    m_t << "\\label{" << stripPath(c->file()) << "_" << c->anchor() << "}";
-    m_t << "\\\\\n";
   }
-
-  setNumCols(t.numColumns());
-  m_t << "\\hline\n";
-
-  // check if first row is a heading and then render the row already here
-  // and end it with \endfirsthead (triggered via m_firstRow==TRUE)
-  // then repeat the row as normal and end it with \endhead (m_firstRow==FALSE)
-  const DocHtmlRow *firstRow = std::get_if<DocHtmlRow>(t.firstRow());
+  // write head row
+  m_t << "{";
   if (firstRow && firstRow->isHeading())
   {
-    setFirstRow(TRUE);
-    if (!isTableNested(t.parent()))
-    {
-      std::visit(*this,*t.firstRow());
-    }
-    setFirstRow(FALSE);
+    m_t << "1";
+  }
+  else
+  {
+    m_t << "0";
   }
+  m_t << "}";
+  m_t << "\n";
+
+  setNumCols(t.numColumns());
+
   visitChildren(t);
   writeEndTableCommand(t.parent());
   popTableState();
@@ -1339,32 +1346,6 @@ void LatexDocVisitor::operator()(const DocHtmlRow &row)
 
   visitChildren(row);
 
-  size_t c=currentColumn();
-  while (c<=numCols()) // end of row while inside a row span?
-  {
-    for (const auto &span : rowSpans())
-    {
-      //printf("  found row span: column=%d rs=%d cs=%d rowIdx=%d cell->rowIdx=%d i=%d c=%d\n",
-      //    span->column, span->rowSpan,span->colSpan,row.rowIndex(),span->cell->rowIndex(),i,c);
-      if (span.rowSpan>0 && span.column==c &&  // we are at a cell in a row span
-          row.rowIndex()>span.cell.rowIndex() // but not the row that started the span
-         )
-      {
-        m_t << "&";
-        if (span.colSpan>1) // row span is also part of a column span
-        {
-          m_t << "\\multicolumn{" << span.colSpan << "}{";
-          m_t <<  "}|}{}";
-        }
-        else // solitary row span
-        {
-          m_t << "\\multicolumn{1}{c|}{}";
-        }
-      }
-    }
-    c++;
-  }
-
   m_t << "\\\\";
 
   size_t col = 1;
@@ -1377,7 +1358,6 @@ void LatexDocVisitor::operator()(const DocHtmlRow &row)
     }
     else if (span.column>col)
     {
-      m_t << "\\cline{" << col << "-" << (span.column-1) << "}";
       col = span.column+span.colSpan;
     }
     else
@@ -1386,142 +1366,110 @@ void LatexDocVisitor::operator()(const DocHtmlRow &row)
     }
   }
 
-  if (col <= numCols())
-  {
-    m_t << "\\cline{" << col << "-" << numCols() << "}";
-  }
-
   m_t << "\n";
-
-  const DocNodeVariant *n = ::parent(row.parent());
-  if (row.isHeading() && row.rowIndex()==1 && !isTableNested(n))
-  {
-    if (firstRow())
-    {
-      m_t << "\\endfirsthead\n";
-      m_t << "\\hline\n";
-      m_t << "\\endfoot\n";
-      m_t << "\\hline\n";
-    }
-    else
-    {
-      m_t << "\\endhead\n";
-    }
-  }
 }
 
 void LatexDocVisitor::operator()(const DocHtmlCell &c)
 {
   if (m_hide) return;
-
-  const DocHtmlRow *row = std::get_if<DocHtmlRow>(c.parent());
+  //printf("Cell(r=%u,c=%u) rowSpan=%d colSpan=%d currentColumn()=%zu\n",c.rowIndex(),c.columnIndex(),c.rowSpan(),c.colSpan(),currentColumn());
 
   setCurrentColumn(currentColumn()+1);
 
-  //Skip columns that span from above.
-  for (const auto &span : rowSpans())
+  QCString cellOpts;
+  QCString cellSpec;
+  auto appendOpt = [&cellOpts](const QCString &s)
   {
-    if (span.rowSpan>0 && span.column==currentColumn())
+    if (!cellOpts.isEmpty()) cellOpts+=",";
+    cellOpts+=s;
+  };
+  auto appendSpec = [&cellSpec](const QCString &s)
+  {
+    if (!cellSpec.isEmpty()) cellSpec+=",";
+    cellSpec+=s;
+  };
+  auto writeCell = [this,&cellOpts,&cellSpec]()
+  {
+    if (!cellOpts.isEmpty() || !cellSpec.isEmpty())
     {
-      if (row && span.colSpan>1)
-      {
-        m_t << "\\multicolumn{" << span.colSpan << "}{";
-        if (currentColumn() /*c.columnIndex()*/==1) // add extra | for first column
-        {
-          m_t << "|";
-        }
-        m_t << "l|}{" << (c.isHeading()? "\\columncolor{\\tableheadbgcolor}" : "") << "}"; // alignment not relevant, empty column
-        setCurrentColumn(currentColumn()+span.colSpan);
-      }
-      else
+      m_t << "\\SetCell";
+      if (!cellOpts.isEmpty())
       {
-        setCurrentColumn(currentColumn()+1);
+        m_t << "[" << cellOpts << "]";
       }
-      m_t << "&";
+      m_t << "{" << cellSpec << "}";
     }
-  }
+  };
 
-  int cs = c.colSpan();
-  int a = c.alignment();
-  if (cs>1 && row)
+  // skip over columns that have a row span starting at an earlier row
+  for (const auto &span : rowSpans())
   {
-    setInColSpan(TRUE);
-    m_t << "\\multicolumn{" << cs << "}{";
-    if (c.columnIndex()==1) // add extra | for first column
-    {
-      m_t << "|";
-    }
-    switch (a)
+    //printf("span(r=%u,c=%u): column=%zu colSpan=%zu,rowSpan=%zu currentColumn()=%zu\n",
+    //    span.cell.rowIndex(),span.cell.columnIndex(),
+    //    span.column,span.colSpan,span.rowSpan,
+    //    currentColumn());
+    if (span.rowSpan>0 && span.column==currentColumn())
     {
-      case DocHtmlCell::Right:
-        m_t << "r|}{";
-        break;
-      case DocHtmlCell::Center:
-        m_t << "c|}{";
-        break;
-      default:
-        m_t << "l|}{";
-        break;
+      setCurrentColumn(currentColumn()+span.colSpan);
+      for (size_t i=0;i<span.colSpan;i++)
+      {
+        m_t << "&";
+      }
     }
   }
+
+  int cs = c.colSpan();
+  int ha = c.alignment();
   int rs = c.rowSpan();
   int va = c.valignment();
-  if (rs>0)
+
+  switch (ha) // horizontal alignment
   {
-    setInRowSpan(TRUE);
-    m_t << "\\multirow";
-    switch(va)
-    {
-      case DocHtmlCell::Top:
-        m_t << "[t]";
-        break;
-      case DocHtmlCell::Bottom:
-        m_t << "[b]";
-        break;
-      case DocHtmlCell::Middle:
-        break; // No alignment option needed
-      default:
-        break;
-    }
-    //printf("adding row span: cell={r=%d c=%d rs=%d cs=%d} curCol=%d\n",
+    case DocHtmlCell::Right:
+      appendSpec("r");
+      break;
+    case DocHtmlCell::Center:
+      appendSpec("c");
+      break;
+    default:
+      // default
+      break;
+  }
+  if (rs>0) // row span
+  {
+    appendOpt("r="+QCString().setNum(rs));
+    //printf("adding row span: cell={r=%d c=%d rs=%d cs=%d} curCol=%zu\n",
     //                       c.rowIndex(),c.columnIndex(),c.rowSpan(),c.colSpan(),
     //                       currentColumn());
     addRowSpan(ActiveRowSpan(c,rs,cs,currentColumn()));
-    m_t << "{" << rs << "}{*}{";
   }
-  if (a==DocHtmlCell::Center)
+  if (cs>1) // column span
   {
-    m_t << "\\PBS\\centering ";
-  }
-  else if (a==DocHtmlCell::Right)
-  {
-    m_t << "\\PBS\\raggedleft ";
-  }
-  if (c.isHeading())
-  {
-    m_t << "\\cellcolor{\\tableheadbgcolor}\\textbf{ ";
+    // update column to the end of the span, needs to be done *after* calling addRowSpan()
+    setCurrentColumn(currentColumn()+cs-1);
+    appendOpt("c="+QCString().setNum(cs));
   }
-  if (cs>1)
+  switch(va) // vertical alignment
   {
-    setCurrentColumn(currentColumn()+cs-1);
+    case DocHtmlCell::Top:
+      appendSpec("h");
+      break;
+    case DocHtmlCell::Bottom:
+      appendSpec("f");
+      break;
+    case DocHtmlCell::Middle:
+      // default
+      break;
   }
+  writeCell();
 
   visitChildren(c);
 
-  if (c.isHeading())
+  for (int i=0;i<cs-1;i++)
   {
-    m_t << "}";
-  }
-  if (inRowSpan())
-  {
-    setInRowSpan(FALSE);
-    m_t << "}";
-  }
-  if (inColSpan())
-  {
-    setInColSpan(FALSE);
-    m_t << "}";
+    m_t << "&"; // placeholder for invisible cell
   }
+
   if (!c.isLast()) m_t << "&";
 }
 

src/latexdocvisitor.h

@@ -188,8 +188,6 @@ class LatexDocVisitor : public DocVisitor
       RowSpanList rowSpans;
       size_t numCols = 0;
       size_t currentColumn = 0;
-      bool inRowSpan = false;
-      bool inColSpan = false;
       bool firstRow = false;
     };
     std::stack<TableState> m_tableStateStack; // needed for nested tables
@@ -229,22 +227,6 @@ class LatexDocVisitor : public DocVisitor
     {
       if (!m_tableStateStack.empty()) m_tableStateStack.top().numCols = num;
     }
-    bool inRowSpan() const
-    {
-      return !m_tableStateStack.empty() ? m_tableStateStack.top().inRowSpan : FALSE;
-    }
-    void setInRowSpan(bool b)
-    {
-      if (!m_tableStateStack.empty()) m_tableStateStack.top().inRowSpan = b;
-    }
-    bool inColSpan() const
-    {
-      return !m_tableStateStack.empty() ? m_tableStateStack.top().inColSpan : FALSE;
-    }
-    void setInColSpan(bool b)
-    {
-      if (!m_tableStateStack.empty()) m_tableStateStack.top().inColSpan = b;
-    }
     bool firstRow() const
     {
       return !m_tableStateStack.empty() ? m_tableStateStack.top().firstRow : FALSE;