]> git.lyx.org Git - features.git/blobdiff - src/output_docbook.cpp
Move include of own header to the top. Fix dependencies
[features.git] / src / output_docbook.cpp
index cf3873bd7a3c6749b4b86acdd1494fc0bc9fd53b..63cae8a58bb69ae9b42ba0bf604cb8a4fa3110e1 100644 (file)
@@ -11,6 +11,8 @@
 
 #include <config.h>
 
+#include "output_docbook.h"
+
 #include "Buffer.h"
 #include "buffer_funcs.h"
 #include "BufferParams.h"
 #include "insets/InsetBibtex.h"
 #include "insets/InsetBibitem.h"
 #include "insets/InsetLabel.h"
+#include "mathed/InsetMath.h"
 #include "insets/InsetNote.h"
 
 #include "support/lassert.h"
+#include "support/textutils.h"
 
 #include <stack>
 #include <iostream>
@@ -293,7 +297,8 @@ void openParTag(XMLStream & xs, const Paragraph * par, const Paragraph * prevpar
        if (prevpar != nullptr) {
                Layout const & prevlay = prevpar->layout();
                if (prevlay.docbookwrappertag() != "NONE") {
-                       if (prevlay.docbookwrappertag() == lay.docbookwrappertag())
+                       if (prevlay.docbookwrappertag() == lay.docbookwrappertag() &&
+                                       prevlay.docbookwrapperattr() == lay.docbookwrapperattr())
                                openWrapper = !lay.docbookwrappermergewithprevious();
                        else
                                openWrapper = true;
@@ -307,10 +312,12 @@ void openParTag(XMLStream & xs, const Paragraph * par, const Paragraph * prevpar
        const string & tag = lay.docbooktag();
        if (tag != "NONE") {
                auto xmltag = xml::ParTag(tag, lay.docbookattr());
-               if (!xs.isTagOpen(xmltag, 1)) // Don't nest a paragraph directly in a paragraph.
+               if (!xs.isTagOpen(xmltag, 1)) // Don't nest a paragraph directly in a paragraph.
                        // TODO: required or not?
                        // TODO: avoid creating a ParTag object just for this query...
                        openTag(xs, lay.docbooktag(), lay.docbookattr(), lay.docbooktagtype());
+                       openTag(xs, lay.docbookinnertag(), lay.docbookinnerattr(), lay.docbookinnertagtype());
+               }
        }
 
        openTag(xs, lay.docbookitemtag(), lay.docbookitemattr(), lay.docbookitemtagtype());
@@ -329,7 +336,8 @@ void closeParTag(XMLStream & xs, Paragraph const * par, Paragraph const * nextpa
        if (nextpar != nullptr) {
                Layout const & nextlay = nextpar->layout();
                if (nextlay.docbookwrappertag() != "NONE") {
-                       if (nextlay.docbookwrappertag() == lay.docbookwrappertag())
+                       if (nextlay.docbookwrappertag() == lay.docbookwrappertag() &&
+                                       nextlay.docbookwrapperattr() == lay.docbookwrapperattr())
                                closeWrapper = !nextlay.docbookwrappermergewithprevious();
                        else
                                closeWrapper = true;
@@ -339,43 +347,13 @@ void closeParTag(XMLStream & xs, Paragraph const * par, Paragraph const * nextpa
        // Main logic.
        closeTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnertagtype());
        closeTag(xs, lay.docbookitemtag(), lay.docbookitemtagtype());
+       closeTag(xs, lay.docbookinnertag(), lay.docbookinnertagtype());
        closeTag(xs, lay.docbooktag(), lay.docbooktagtype());
        if (closeWrapper)
                closeTag(xs, lay.docbookwrappertag(), lay.docbookwrappertagtype());
 }
 
 
-void openLabelTag(XMLStream & xs, Layout const & lay) // Mostly for definition lists.
-{
-       openTag(xs, lay.docbookitemlabeltag(), lay.docbookitemlabelattr(), lay.docbookitemlabeltagtype());
-}
-
-
-void closeLabelTag(XMLStream & xs, Layout const & lay)
-{
-       closeTag(xs, lay.docbookitemlabeltag(), lay.docbookitemlabeltagtype());
-}
-
-
-void openItemTag(XMLStream & xs, Layout const & lay)
-{
-       openTag(xs, lay.docbookitemtag(), lay.docbookitemattr(), lay.docbookitemtagtype());
-}
-
-
-void closeItemTag(XMLStream & xs, Layout const & lay)
-{
-       closeTag(xs, lay.docbookitemtag(), lay.docbookitemtagtype());
-}
-
-
-ParagraphList::const_iterator makeAny(Text const &,
-                                             Buffer const &,
-                                             XMLStream &,
-                                             OutputParams const &,
-                                             ParagraphList::const_iterator);
-
-
 void makeBibliography(
                Text const & text,
                Buffer const & buf,
@@ -384,8 +362,8 @@ void makeBibliography(
                ParagraphList::const_iterator const & par)
 {
        // If this is the first paragraph in a bibliography, open the bibliography tag.
-       auto pbegin_before = text.paragraphs().getParagraphBefore(par);
-       if (pbegin_before->layout().latextype != LATEX_BIB_ENVIRONMENT) {
+       auto const * pbegin_before = text.paragraphs().getParagraphBefore(par);
+       if (pbegin_before == nullptr || (pbegin_before && pbegin_before->layout().latextype != LATEX_BIB_ENVIRONMENT)) {
                xs << xml::StartTag("bibliography");
                xs << xml::CR();
        }
@@ -471,29 +449,35 @@ void makeParagraph(
        // Plain layouts must be ignored.
        special_case |= buf.params().documentClass().isPlainLayout(par->layout()) && !runparams.docbook_force_pars;
        // Equations do not deserve their own paragraph (DocBook allows them outside paragraphs).
-       special_case |= nInsets == par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
-               return inset.inset && inset.inset->asInsetMath();
+       // Exception: any case that generates an <inlineequation> must still get a paragraph to be valid.
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset && inset.inset->asInsetMath() && inset.inset->asInsetMath()->getType() != hullSimple;
+       });
+       // Floats cannot be in paragraphs.
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset->lyxCode() == FLOAT_CODE;
+       });
+       // Bibliographies cannot be in paragraphs. Bibitems should still be handled as paragraphs, though
+       // (see makeParagraphBibliography).
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset->lyxCode() == BIBTEX_CODE;
+       });
+       // ERTs are in comments, not paragraphs.
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset->lyxCode() == ERT_CODE;
+       });
+       // Listings should not get into their own paragraph.
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset->lyxCode() == LISTINGS_CODE;
+       });
+       // Boxes cannot get into their own paragraph.
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset->lyxCode() == BOX_CODE;
+       });
+       // Includes should not have a paragraph.
+       special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
+               return inset.inset->lyxCode() == INCLUDE_CODE;
        });
-
-       // TODO: Could get rid of this with a DocBook equivalent to htmlisblock? Not for all cases, unfortunately... See above for those that have been determined not to be allowable for this potential refactoring.
-       if (!special_case && par->size() == 1 && par->getInset(0)) {
-               Inset const * firstInset = par->getInset(0);
-
-               // Floats cannot be in paragraphs.
-               special_case = to_utf8(firstInset->layoutName()).substr(0, 6) == "Float:";
-
-               // Bibliographies cannot be in paragraphs.
-               if (!special_case && firstInset->asInsetCommand())
-                       special_case = firstInset->asInsetCommand()->params().getCmdName() == "bibtex";
-
-               // ERTs are in comments, not paragraphs.
-               if (!special_case && firstInset->lyxCode() == lyx::ERT_CODE)
-                       special_case = true;
-
-               // Listings should not get into their own paragraph.
-               if (!special_case && firstInset->lyxCode() == lyx::LISTINGS_CODE)
-                       special_case = true;
-       }
 
        bool const open_par = runparams.docbook_make_pars
                                                  && !runparams.docbook_in_par
@@ -514,8 +498,8 @@ void makeParagraph(
        auto nextpar = par;
        ++nextpar;
        auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(distance(begin, par)), 0, nextpar == end, special_case);
-       for (auto & parXML : pars) {
-               if (!std::all_of(parXML.begin(), parXML.end(), ::isspace)) {
+       for (docstring const & parXML : pars) {
+               if (xml::isNotOnlySpace(parXML)) {
                        if (open_par)
                                openParTag(xs, &*par, prevpar);
 
@@ -650,17 +634,17 @@ ParagraphList::const_iterator makeListEnvironment(Text const &text,
                if (style.labeltype != LABEL_NO_LABEL && style.docbookitemlabeltag() != "NONE") {
                        if (style.labeltype == LABEL_MANUAL) {
                                // Only variablelist gets here (or similar items defined as an extension in the layout).
-                               openLabelTag(xs, style);
+                               openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
                                sep = 1 + par->firstWordDocBook(xs, runparams);
-                               closeLabelTag(xs, style);
+                               closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
                        } else {
                                // Usual cases: maybe there is something specified at the layout level. Highly unlikely, though.
                                docstring const lbl = par->params().labelString();
 
                                if (!lbl.empty()) {
-                                       openLabelTag(xs, style);
+                                       openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
                                        xs << lbl;
-                                       closeLabelTag(xs, style);
+                                       closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
                                }
                        }
                }
@@ -732,35 +716,6 @@ void makeCommand(
 }
 
 
-ParagraphList::const_iterator makeAny(Text const &text,
-                                             Buffer const &buf,
-                                             XMLStream &xs,
-                                             OutputParams const &runparams,
-                                             ParagraphList::const_iterator par)
-{
-       switch (par->layout().latextype) {
-       case LATEX_COMMAND:
-               makeCommand(text, buf, xs, runparams, par);
-               break;
-       case LATEX_ENVIRONMENT:
-               makeEnvironment(text, buf, xs, runparams, par);
-               break;
-       case LATEX_LIST_ENVIRONMENT:
-       case LATEX_ITEM_ENVIRONMENT:
-               // Only case when makeAny() might consume more than one paragraph.
-               return makeListEnvironment(text, buf, xs, runparams, par);
-       case LATEX_PARAGRAPH:
-               makeParagraph(text, buf, xs, runparams, par);
-               break;
-       case LATEX_BIB_ENVIRONMENT:
-               makeBibliography(text, buf, xs, runparams, par);
-               break;
-       }
-       ++par;
-       return par;
-}
-
-
 bool isLayoutSectioning(Layout const & lay)
 {
        return lay.category() == from_utf8("Sectioning");
@@ -880,6 +835,35 @@ DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs,
 } // end anonymous namespace
 
 
+ParagraphList::const_iterator makeAny(Text const &text,
+                                      Buffer const &buf,
+                                      XMLStream &xs,
+                                      OutputParams const &runparams,
+                                      ParagraphList::const_iterator par)
+{
+       switch (par->layout().latextype) {
+       case LATEX_COMMAND:
+               makeCommand(text, buf, xs, runparams, par);
+               break;
+       case LATEX_ENVIRONMENT:
+               makeEnvironment(text, buf, xs, runparams, par);
+               break;
+       case LATEX_LIST_ENVIRONMENT:
+       case LATEX_ITEM_ENVIRONMENT:
+               // Only case when makeAny() might consume more than one paragraph.
+               return makeListEnvironment(text, buf, xs, runparams, par);
+       case LATEX_PARAGRAPH:
+               makeParagraph(text, buf, xs, runparams, par);
+               break;
+       case LATEX_BIB_ENVIRONMENT:
+               makeBibliography(text, buf, xs, runparams, par);
+               break;
+       }
+       ++par;
+       return par;
+}
+
+
 xml::FontTag docbookStartFontTag(xml::FontTypes type)
 {
        return xml::FontTag(from_utf8(fontToDocBookTag(type)), from_utf8(fontToAttribute(type)), type);
@@ -917,7 +901,7 @@ void outputDocBookInfo(
                // even though they must be properly output if there is some abstract.
                abstract = os2.str();
                docstring cleaned = abstract;
-               cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), ::isspace), cleaned.end());
+               cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), lyx::isSpace), cleaned.end());
 
                // Nothing? Then there is no abstract!
                if (cleaned.empty())
@@ -941,6 +925,15 @@ void outputDocBookInfo(
        for (auto pit : info.mustBeInInfo)
                makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 
+       // If there is no title, generate one (required for the document to be valid).
+       // This code is called for the main document, for table cells, etc., so be precise in this condition.
+       if (text.isMainText() && info.shouldBeInInfo.empty() && !runparams.inInclude) {
+               xs << xml::StartTag("title");
+               xs << "Untitled Document";
+               xs << xml::EndTag("title");
+               xs << xml::CR();
+       }
+
        // Always output the abstract as the last item of the <info>, as it requires special treatment (especially if
        // it contains several paragraphs that are empty).
        if (hasAbstract) {
@@ -1111,8 +1104,7 @@ void docbookParagraphs(Text const &text,
 
                // Close all sections before the bibliography.
                // TODO: Only close all when the bibliography is at the end of the document? Or force to output the bibliography at the end of the document? Or don't care (as allowed by DocBook)?
-               auto insetsLength = distance(par->insetList().begin(), par->insetList().end());
-               if (insetsLength > 0) {
+               if (!par->insetList().empty()) {
                        Inset const *firstInset = par->getInset(0);
                        if (firstInset && (firstInset->lyxCode() == BIBITEM_CODE || firstInset->lyxCode() == BIBTEX_CODE)) {
                                while (!headerLevels.empty()) {