DocBook: fix issues with nested labeling lists.

[features.git] / src / output_docbook.cpp

diff --git a/src/output_docbook.cpp b/src/output_docbook.cpp
index 2224cd8318ed399069858f1a54a6fed83341a1e2..489230d5cc1eb0c3093e9bbcd7a414baee4fef3a 100644 (file)
--- a/src/output_docbook.cpp
+++ b/src/output_docbook.cpp
@@ -257,7 +257,8 @@ void closeInnerItemTag(XMLStream &xs, Layout const &lay)
 
 inline void closeItemTag(XMLStream &xs, Layout const &lay)
 {
-       xs << xml::EndTag(lay.docbookitemtag()) << xml::CR();
+       xs << xml::EndTag(lay.docbookitemtag());
+       xs << xml::CR();
 }
 
 // end of convenience functions
@@ -508,10 +509,14 @@ ParagraphList::const_iterator makeEnvironment(
                                LATTEST(bstyle == style);
                                if (lastlay != nullptr) {
                                        closeItemTag(xs, *lastlay);
+                                       if (lastlay->docbookitemwrappertag() != "NONE") {
+                                               xs << xml::EndTag(lastlay->docbookitemwrappertag());
+                                               xs << xml::CR();
+                                       }
                                        lastlay = nullptr;
                                }
 
-                               // this will be positive, if we want to skip the
+                               // this will be positive if we want to skip the
                                // initial word (if it's been taken for the label).
                                pos_type sep = 0;
 
@@ -554,13 +559,35 @@ ParagraphList::const_iterator makeEnvironment(
                                        }
                                } // end label output
 
+                               // Start generating the item.
                                bool wasInParagraph = runparams.docbook_in_par;
                                openItemTag(xs, style);
                                bool getsIntoParagraph = openInnerItemTag(xs, style);
                                OutputParams rp = runparams;
                                rp.docbook_in_par = wasInParagraph | getsIntoParagraph;
 
-                               par->simpleDocBookOnePar(buf, xs, rp, text.outerFont(distance(begin, par)), true, true, sep);
+                               // Maybe the item is completely empty, i.e. if the first word ends at the end of the current paragraph
+                               // AND if the next paragraph doesn't have the same depth (if there is such a paragraph).
+                               // Common case: there is only the first word on the line, but there is a nested list instead.
+                               bool emptyItem = false;
+                               if (sep == par->size()) {
+                                       auto next_par = par;
+                                       ++next_par;
+                                       if (next_par == text.paragraphs().end()) // There is no next paragraph.
+                                               emptyItem = true;
+                                       else // There is a next paragraph: check depth.
+                                               emptyItem = par->params().depth() > next_par->params().depth();
+                               }
+
+                               if (emptyItem) {
+                                       // Avoid having an empty item, this is not valid DocBook. A single character is enough to force
+                                       // generation of a full <para>.
+                                       xs << ' ';
+                               } else {
+                                       // Generate the rest of the paragraph, if need be.
+                                       par->simpleDocBookOnePar(buf, xs, rp, text.outerFont(distance(begin, par)), true, true, sep);
+                               }
+
                                ++par;
                                if (getsIntoParagraph)
                                        closeInnerItemTag(xs, style);
@@ -585,8 +612,7 @@ ParagraphList::const_iterator makeEnvironment(
                                        }
                                }
                        }
-                       // The other possibility is that the depth has increased, in which
-                       // case we need to recurse.
+                       // The other possibility is that the depth has increased.
                        else {
                                send = findEndOfEnvironment(par, pend);
                                par = makeEnvironment(buf, xs, runparams, text, par, send);
@@ -607,8 +633,13 @@ ParagraphList::const_iterator makeEnvironment(
                }
        }
 
-       if (lastlay != 0)
+       if (lastlay != nullptr) {
                closeItemTag(xs, *lastlay);
+               if (lastlay->docbookitemwrappertag() != "NONE") {
+                       xs << xml::EndTag(lastlay->docbookitemwrappertag());
+                       xs << xml::CR();
+               }
+       }
        closeTag(xs, bstyle);
        xs << xml::CR();
        return pend;
@@ -725,10 +756,6 @@ DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs, pit_type c
                // Based on layout information, store this paragraph in one set: should be in <info>, must be.
                Layout const &style = par.layout();
 
-               std::cout << "Name: " << to_utf8(style.name()) << std::endl;
-               std::cout << "  DocBook tag: " << style.docbooktag() << std::endl;
-               std::cout << "  In info: " << style.docbookininfo() << std::endl;
-
                if (style.docbookininfo() == "always") {
                        mustBeInInfo.emplace(cpit);
                } else if (style.docbookininfo() == "maybe") {
@@ -790,14 +817,11 @@ pit_type generateDocBookParagraphWithoutSectioning(
                        (epit == (int) paragraphs.size()) ?
                        paragraphs.end() : paragraphs.iterator_at(epit);
 
-       std::cout << "generateDocBookParagraphWithoutSectioning" << std::endl;
        while (bpit < epit) {
-               std::cout << "iteration; bpit: " << bpit << std::endl;
                tie(par, send) = makeAny(text, buf, xs, runparams, par, send, pend);
                bpit += distance(lastStartedPar, par);
                lastStartedPar = par;
        }
-       std::cout << "generateDocBookParagraphWithoutSectioning has looped; bpit: " << bpit << std::endl;
 
        return bpit;
 }