src/output_docbook.cpp

   1 /**
   2  * \file output_docbook.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author José Matos
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "output_docbook.h"
  15
  16 #include "Buffer.h"
  17 #include "buffer_funcs.h"
  18 #include "BufferParams.h"
  19 #include "Font.h"
  20 #include "InsetList.h"
  21 #include "Paragraph.h"
  22 #include "ParagraphList.h"
  23 #include "ParagraphParameters.h"
  24 #include "xml.h"
  25 #include "Text.h"
  26 #include "TextClass.h"
  27
  28 #include "insets/InsetBibtex.h"
  29 #include "insets/InsetBibitem.h"
  30 #include "insets/InsetLabel.h"
  31 #include "mathed/InsetMath.h"
  32 #include "insets/InsetNote.h"
  33
  34 #include "support/lassert.h"
  35 #include "support/textutils.h"
  36
  37 #include <stack>
  38 #include <iostream>
  39 #include <algorithm>
  40 #include <sstream>
  41
  42 using namespace std;
  43 using namespace lyx::support;
  44
  45 namespace lyx {
  46
  47 namespace {
  48
  49 std::string fontToDocBookTag(xml::FontTypes type)
  50 {
  51         switch (type) {
  52         case xml::FontTypes::FT_EMPH:
  53         case xml::FontTypes::FT_BOLD:
  54                 return "emphasis";
  55         case xml::FontTypes::FT_NOUN:
  56                 return "personname";
  57         case xml::FontTypes::FT_UBAR:
  58         case xml::FontTypes::FT_WAVE:
  59         case xml::FontTypes::FT_DBAR:
  60         case xml::FontTypes::FT_SOUT:
  61         case xml::FontTypes::FT_XOUT:
  62         case xml::FontTypes::FT_ITALIC:
  63         case xml::FontTypes::FT_UPRIGHT:
  64         case xml::FontTypes::FT_SLANTED:
  65         case xml::FontTypes::FT_SMALLCAPS:
  66         case xml::FontTypes::FT_ROMAN:
  67         case xml::FontTypes::FT_SANS:
  68                 return "emphasis";
  69         case xml::FontTypes::FT_TYPE:
  70                 return "code";
  71         case xml::FontTypes::FT_SIZE_TINY:
  72         case xml::FontTypes::FT_SIZE_SCRIPT:
  73         case xml::FontTypes::FT_SIZE_FOOTNOTE:
  74         case xml::FontTypes::FT_SIZE_SMALL:
  75         case xml::FontTypes::FT_SIZE_NORMAL:
  76         case xml::FontTypes::FT_SIZE_LARGE:
  77         case xml::FontTypes::FT_SIZE_LARGER:
  78         case xml::FontTypes::FT_SIZE_LARGEST:
  79         case xml::FontTypes::FT_SIZE_HUGE:
  80         case xml::FontTypes::FT_SIZE_HUGER:
  81         case xml::FontTypes::FT_SIZE_INCREASE:
  82         case xml::FontTypes::FT_SIZE_DECREASE:
  83                 return "emphasis";
  84         default:
  85                 return "";
  86         }
  87 }
  88
  89
  90 string fontToRole(xml::FontTypes type)
  91 {
  92         // Specific fonts are achieved with roles. The only common ones are "" for basic emphasis,
  93         // and "bold"/"strong" for bold. With some specific options, other roles are copied into
  94         // HTML output (via the DocBook XSLT sheets); otherwise, if not recognised, they are just ignored.
  95         // Hence, it is not a problem to have many roles by default here.
  96         // See https://www.sourceware.org/ml/docbook/2003-05/msg00269.html
  97         switch (type) {
  98         case xml::FontTypes::FT_ITALIC:
  99         case xml::FontTypes::FT_EMPH:
 100                 return "";
 101         case xml::FontTypes::FT_BOLD:
 102                 return "bold";
 103         case xml::FontTypes::FT_NOUN: // Outputs a <person>
 104         case xml::FontTypes::FT_TYPE: // Outputs a <code>
 105                 return "";
 106         case xml::FontTypes::FT_UBAR:
 107                 return "underline";
 108
 109         // All other roles are non-standard for DocBook.
 110
 111         case xml::FontTypes::FT_WAVE:
 112                 return "wave";
 113         case xml::FontTypes::FT_DBAR:
 114                 return "dbar";
 115         case xml::FontTypes::FT_SOUT:
 116                 return "sout";
 117         case xml::FontTypes::FT_XOUT:
 118                 return "xout";
 119         case xml::FontTypes::FT_UPRIGHT:
 120                 return "upright";
 121         case xml::FontTypes::FT_SLANTED:
 122                 return "slanted";
 123         case xml::FontTypes::FT_SMALLCAPS:
 124                 return "smallcaps";
 125         case xml::FontTypes::FT_ROMAN:
 126                 return "roman";
 127         case xml::FontTypes::FT_SANS:
 128                 return "sans";
 129         case xml::FontTypes::FT_SIZE_TINY:
 130                 return "tiny";
 131         case xml::FontTypes::FT_SIZE_SCRIPT:
 132                 return "size_script";
 133         case xml::FontTypes::FT_SIZE_FOOTNOTE:
 134                 return "size_footnote";
 135         case xml::FontTypes::FT_SIZE_SMALL:
 136                 return "size_small";
 137         case xml::FontTypes::FT_SIZE_NORMAL:
 138                 return "size_normal";
 139         case xml::FontTypes::FT_SIZE_LARGE:
 140                 return "size_large";
 141         case xml::FontTypes::FT_SIZE_LARGER:
 142                 return "size_larger";
 143         case xml::FontTypes::FT_SIZE_LARGEST:
 144                 return "size_largest";
 145         case xml::FontTypes::FT_SIZE_HUGE:
 146                 return "size_huge";
 147         case xml::FontTypes::FT_SIZE_HUGER:
 148                 return "size_huger";
 149         case xml::FontTypes::FT_SIZE_INCREASE:
 150                 return "size_increase";
 151         case xml::FontTypes::FT_SIZE_DECREASE:
 152                 return "size_decrease";
 153         default:
 154                 return "";
 155         }
 156 }
 157
 158
 159 string fontToAttribute(xml::FontTypes type) {
 160         // If there is a role (i.e. nonstandard use of a tag), output the attribute. Otherwise, the sheer tag is sufficient
 161         // for the font.
 162         string role = fontToRole(type);
 163         if (!role.empty()) {
 164                 return "role='" + role + "'";
 165         } else {
 166                 return "";
 167         }
 168 }
 169
 170
 171 // Convenience functions to open and close tags. First, very low-level ones to ensure a consistent new-line behaviour.
 172 // Block style:
 173 //        Content before
 174 //        <blocktag>
 175 //          Contents of the block.
 176 //        </blocktag>
 177 //        Content after
 178 // Paragraph style:
 179 //        Content before
 180 //          <paratag>Contents of the paragraph.</paratag>
 181 //        Content after
 182 // Inline style:
 183 //    Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
 184
 185 void openInlineTag(XMLStream & xs, const std::string & tag, const std::string & attr)
 186 {
 187         xs << xml::StartTag(tag, attr);
 188 }
 189
 190
 191 void closeInlineTag(XMLStream & xs, const std::string & tag)
 192 {
 193         xs << xml::EndTag(tag);
 194 }
 195
 196
 197 void openParTag(XMLStream & xs, const std::string & tag, const std::string & attr)
 198 {
 199         if (!xs.isLastTagCR())
 200                 xs << xml::CR();
 201         xs << xml::StartTag(tag, attr);
 202 }
 203
 204
 205 void closeParTag(XMLStream & xs, const std::string & tag)
 206 {
 207         xs << xml::EndTag(tag);
 208         xs << xml::CR();
 209 }
 210
 211
 212 void openBlockTag(XMLStream & xs, const std::string & tag, const std::string & attr)
 213 {
 214         if (!xs.isLastTagCR())
 215                 xs << xml::CR();
 216         xs << xml::StartTag(tag, attr);
 217         xs << xml::CR();
 218 }
 219
 220
 221 void closeBlockTag(XMLStream & xs, const std::string & tag)
 222 {
 223         if (!xs.isLastTagCR())
 224                 xs << xml::CR();
 225         xs << xml::EndTag(tag);
 226         xs << xml::CR();
 227 }
 228
 229
 230 void openTag(XMLStream & xs, const std::string & tag, const std::string & attr, const std::string & tagtype)
 231 {
 232         if (tag.empty() || tag == "NONE") // Common check to be performed elsewhere, if it was not here.
 233                 return;
 234
 235         if (tag == "para" || tagtype == "paragraph") // Special case for <para>: always considered as a paragraph.
 236                 openParTag(xs, tag, attr);
 237         else if (tagtype == "block")
 238                 openBlockTag(xs, tag, attr);
 239         else if (tagtype == "inline")
 240                 openInlineTag(xs, tag, attr);
 241         else
 242                 xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + " " + attr + "'");
 243 }
 244
 245
 246 void closeTag(XMLStream & xs, const std::string & tag, const std::string & tagtype)
 247 {
 248         if (tag.empty() || tag == "NONE")
 249                 return;
 250
 251         if (tag == "para" || tagtype == "paragraph") // Special case for <para>: always considered as a paragraph.
 252                 closeParTag(xs, tag);
 253         else if (tagtype == "block")
 254                 closeBlockTag(xs, tag);
 255         else if (tagtype == "inline")
 256                 closeInlineTag(xs, tag);
 257         else
 258                 xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + "'");
 259 }
 260
 261
 262 void compTag(XMLStream & xs, const std::string & tag, const std::string & attr, const std::string & tagtype)
 263 {
 264         if (tag.empty() || tag == "NONE")
 265                 return;
 266
 267         // Special case for <para>: always considered as a paragraph.
 268         if (tag == "para" || tagtype == "paragraph" || tagtype == "block") {
 269                 if (!xs.isLastTagCR())
 270                         xs << xml::CR();
 271                 xs << xml::CompTag(tag, attr);
 272                 xs << xml::CR();
 273         } else if (tagtype == "inline") {
 274                 xs << xml::CompTag(tag, attr);
 275         } else {
 276                 xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + "'");
 277         }
 278 }
 279
 280
 281 // Higher-level convenience functions.
 282
 283 void openParTag(XMLStream & xs, const Paragraph * par, const Paragraph * prevpar)
 284 {
 285         Layout const & lay = par->layout();
 286
 287         if (par == prevpar)
 288                 prevpar = nullptr;
 289
 290         // When should the wrapper be opened here? Only if the previous paragraph has the SAME wrapper tag
 291         // (usually, they won't have the same layout) and the CURRENT one allows merging.
 292         // The main use case is author information in several paragraphs: if the name of the author is the
 293         // first paragraph of an author, then merging with the previous tag does not make sense. Say the
 294         // next paragraph is the affiliation, then it should be output in the same <author> tag (different
 295         // layout, same wrapper tag).
 296         bool openWrapper = lay.docbookwrappertag() != "NONE";
 297         if (prevpar != nullptr) {
 298                 Layout const & prevlay = prevpar->layout();
 299                 if (prevlay.docbookwrappertag() != "NONE") {
 300                         if (prevlay.docbookwrappertag() == lay.docbookwrappertag() &&
 301                                         prevlay.docbookwrapperattr() == lay.docbookwrapperattr())
 302                                 openWrapper = !lay.docbookwrappermergewithprevious();
 303                         else
 304                                 openWrapper = true;
 305                 }
 306         }
 307
 308         // Main logic.
 309         if (openWrapper)
 310                 openTag(xs, lay.docbookwrappertag(), lay.docbookwrapperattr(), lay.docbookwrappertagtype());
 311
 312         const string & tag = lay.docbooktag();
 313         if (tag != "NONE") {
 314                 auto xmltag = xml::ParTag(tag, lay.docbookattr());
 315                 if (!xs.isTagOpen(xmltag, 1)) { // Don't nest a paragraph directly in a paragraph.
 316                         // TODO: required or not?
 317                         // TODO: avoid creating a ParTag object just for this query...
 318                         openTag(xs, lay.docbooktag(), lay.docbookattr(), lay.docbooktagtype());
 319                         openTag(xs, lay.docbookinnertag(), lay.docbookinnerattr(), lay.docbookinnertagtype());
 320                 }
 321         }
 322
 323         openTag(xs, lay.docbookitemtag(), lay.docbookitemattr(), lay.docbookitemtagtype());
 324         openTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnerattr(), lay.docbookiteminnertagtype());
 325 }
 326
 327
 328 void closeParTag(XMLStream & xs, Paragraph const * par, Paragraph const * nextpar)
 329 {
 330         if (par == nextpar)
 331                 nextpar = nullptr;
 332
 333         // See comment in openParTag.
 334         Layout const & lay = par->layout();
 335         bool closeWrapper = lay.docbookwrappertag() != "NONE";
 336         if (nextpar != nullptr) {
 337                 Layout const & nextlay = nextpar->layout();
 338                 if (nextlay.docbookwrappertag() != "NONE") {
 339                         if (nextlay.docbookwrappertag() == lay.docbookwrappertag() &&
 340                                         nextlay.docbookwrapperattr() == lay.docbookwrapperattr())
 341                                 closeWrapper = !nextlay.docbookwrappermergewithprevious();
 342                         else
 343                                 closeWrapper = true;
 344                 }
 345         }
 346
 347         // Main logic.
 348         closeTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnertagtype());
 349         closeTag(xs, lay.docbookitemtag(), lay.docbookitemtagtype());
 350         closeTag(xs, lay.docbookinnertag(), lay.docbookinnertagtype());
 351         closeTag(xs, lay.docbooktag(), lay.docbooktagtype());
 352         if (closeWrapper)
 353                 closeTag(xs, lay.docbookwrappertag(), lay.docbookwrappertagtype());
 354 }
 355
 356
 357 void makeBibliography(
 358                 Text const & text,
 359                 Buffer const & buf,
 360                 XMLStream & xs,
 361                 OutputParams const & runparams,
 362                 ParagraphList::const_iterator const & par)
 363 {
 364         // If this is the first paragraph in a bibliography, open the bibliography tag.
 365         auto const * pbegin_before = text.paragraphs().getParagraphBefore(par);
 366         if (pbegin_before == nullptr || (pbegin_before && pbegin_before->layout().latextype != LATEX_BIB_ENVIRONMENT)) {
 367                 xs << xml::StartTag("bibliography");
 368                 xs << xml::CR();
 369         }
 370
 371         // Start the precooked bibliography entry. This is very much like opening a paragraph tag.
 372         // Don't forget the citation ID!
 373         docstring attr;
 374         for (auto i = 0; i < par->size(); ++i) {
 375                 Inset const *ip = par->getInset(i);
 376                 if (!ip)
 377                         continue;
 378                 if (const auto * bibitem = dynamic_cast<const InsetBibitem*>(ip)) {
 379                         attr = from_utf8("xml:id='") + bibitem->getParam("key") + from_utf8("'");
 380                         break;
 381                 }
 382         }
 383         xs << xml::StartTag(from_utf8("bibliomixed"), attr);
 384
 385         // Generate the entry. Concatenate the different parts of the paragraph if any.
 386         auto const begin = text.paragraphs().begin();
 387         auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(begin, par)), 0);
 388         for (auto & parXML : pars)
 389                 xs << XMLStream::ESCAPE_NONE << parXML;
 390
 391         // End the precooked bibliography entry.
 392         xs << xml::EndTag("bibliomixed");
 393         xs << xml::CR();
 394
 395         // If this is the last paragraph in a bibliography, close the bibliography tag.
 396         auto const end = text.paragraphs().end();
 397         auto nextpar = par;
 398         ++nextpar;
 399         bool endBibliography = nextpar == end || nextpar->layout().latextype != LATEX_BIB_ENVIRONMENT;
 400
 401         if (endBibliography) {
 402                 xs << xml::EndTag("bibliography");
 403                 xs << xml::CR();
 404         }
 405 }
 406
 407
 408 void makeParagraph(
 409                 Text const & text,
 410                 Buffer const & buf,
 411                 XMLStream & xs,
 412                 OutputParams const & runparams,
 413                 ParagraphList::const_iterator const & par)
 414 {
 415         auto const begin = text.paragraphs().begin();
 416         auto const end = text.paragraphs().end();
 417         auto prevpar = text.paragraphs().getParagraphBefore(par);
 418
 419         // We want to open the paragraph tag if:
 420         //   (i) the current layout permits multiple paragraphs
 421         //  (ii) we are either not already inside a paragraph (HTMLIsBlock) OR
 422         //         we are, but this is not the first paragraph
 423         //
 424         // But there is also a special case, and we first see whether we are in it.
 425         // We do not want to open the paragraph tag if this paragraph contains
 426         // only one item, and that item is "inline", i.e., not HTMLIsBlock (such
 427         // as a branch). On the other hand, if that single item has a font change
 428         // applied to it, then we still do need to open the paragraph.
 429         //
 430         // Obviously, this is very fragile. The main reason we need to do this is
 431         // because of branches, e.g., a branch that contains an entire new section.
 432         // We do not really want to wrap that whole thing in a <div>...</div>.
 433         bool special_case = false;
 434         Inset const *specinset = par->size() == 1 ? par->getInset(0) : nullptr;
 435         if (specinset && !specinset->getLayout().htmlisblock()) { // TODO: Convert htmlisblock to a DocBook parameter?
 436                 Layout const &style = par->layout();
 437                 FontInfo const first_font = style.labeltype == LABEL_MANUAL ?
 438                                                                         style.labelfont : style.font;
 439                 FontInfo const our_font =
 440                                 par->getFont(buf.masterBuffer()->params(), 0,
 441                                                          text.outerFont(std::distance(begin, par))).fontInfo();
 442
 443                 if (first_font == our_font)
 444                         special_case = true;
 445         }
 446
 447         size_t nInsets = std::distance(par->insetList().begin(), par->insetList().end());
 448
 449         // Plain layouts must be ignored.
 450         special_case |= buf.params().documentClass().isPlainLayout(par->layout()) && !runparams.docbook_force_pars;
 451         // Equations do not deserve their own paragraph (DocBook allows them outside paragraphs).
 452         // Exception: any case that generates an <inlineequation> must still get a paragraph to be valid.
 453         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 454                 return inset.inset && inset.inset->asInsetMath() && inset.inset->asInsetMath()->getType() != hullSimple;
 455         });
 456         // Floats cannot be in paragraphs.
 457         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 458                 return inset.inset->lyxCode() == FLOAT_CODE;
 459         });
 460         // Bibliographies cannot be in paragraphs. Bibitems should still be handled as paragraphs, though
 461         // (see makeParagraphBibliography).
 462         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 463                 return inset.inset->lyxCode() == BIBTEX_CODE;
 464         });
 465         // ERTs are in comments, not paragraphs.
 466         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 467                 return inset.inset->lyxCode() == ERT_CODE;
 468         });
 469         // Listings should not get into their own paragraph.
 470         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 471                 return inset.inset->lyxCode() == LISTINGS_CODE;
 472         });
 473         // Boxes cannot get into their own paragraph.
 474         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 475                 return inset.inset->lyxCode() == BOX_CODE;
 476         });
 477         // Includes should not have a paragraph.
 478         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 479                 return inset.inset->lyxCode() == INCLUDE_CODE;
 480         });
 481
 482         bool const open_par = runparams.docbook_make_pars
 483                                                   && !runparams.docbook_in_par
 484                                                   && !special_case;
 485
 486         // We want to issue the closing tag if either:
 487         //   (i)  We opened it, and either docbook_in_par is false,
 488         //              or we're not in the last paragraph, anyway.
 489         //   (ii) We didn't open it and docbook_in_par is true,
 490         //              but we are in the first par, and there is a next par.
 491         bool const close_par = open_par && (!runparams.docbook_in_par);
 492
 493         // Determine if this paragraph has some real content. Things like new pages are not caught
 494         // by Paragraph::empty(), even though they do not generate anything useful in DocBook.
 495         // Thus, remove all spaces (including new lines: \r, \n) before checking for emptiness.
 496         // std::all_of allows doing this check without having to copy the string.
 497         // Open and close tags around each contained paragraph.
 498         auto nextpar = par;
 499         ++nextpar;
 500         auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(distance(begin, par)), 0, nextpar == end, special_case);
 501         for (docstring const & parXML : pars) {
 502                 if (xml::isNotOnlySpace(parXML)) {
 503                         if (open_par)
 504                                 openParTag(xs, &*par, prevpar);
 505
 506                         xs << XMLStream::ESCAPE_NONE << parXML;
 507
 508                         if (close_par)
 509                                 closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr);
 510                 }
 511         }
 512 }
 513
 514
 515 void makeEnvironment(Text const &text,
 516                                          Buffer const &buf,
 517                      XMLStream &xs,
 518                      OutputParams const &runparams,
 519                      ParagraphList::const_iterator const & par)
 520 {
 521         auto const end = text.paragraphs().end();
 522         auto nextpar = par;
 523         ++nextpar;
 524
 525         // Special cases for listing-like environments provided in layouts. This is quite ad-hoc, but provides a useful
 526         // default. This should not be used by too many environments (only LyX-Code right now).
 527         // This would be much simpler if LyX-Code was implemented as InsetListings...
 528         bool mimicListing = false;
 529         bool ignoreFonts = false;
 530         if (par->layout().docbooktag() == "programlisting") {
 531                 mimicListing = true;
 532                 ignoreFonts = true;
 533         }
 534
 535         // Output the opening tag for this environment, but only if it has not been previously opened (condition
 536         // implemented in openParTag).
 537         auto prevpar = text.paragraphs().getParagraphBefore(par);
 538         openParTag(xs, &*par, prevpar); // TODO: switch in layout for par/block?
 539
 540         // Generate the contents of this environment. There is a special case if this is like some environment.
 541         Layout const & style = par->layout();
 542         if (style.latextype == LATEX_COMMAND) {
 543                 // Nothing to do (otherwise, infinite loops).
 544         } else if (style.latextype == LATEX_ENVIRONMENT) {
 545                 // Generate the paragraph, if need be.
 546                 auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(text.paragraphs().begin(), par)), 0, false, ignoreFonts);
 547
 548                 if (mimicListing) {
 549                         auto p = pars.begin();
 550                         while (p != pars.end()) {
 551                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), par->layout().docbookiteminnertagtype());
 552                                 xs << XMLStream::ESCAPE_NONE << *p;
 553                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 554                                 ++p;
 555
 556                                 // Insert a new line after each "paragraph" (i.e. line in the listing), except for the last one.
 557                                 // Otherwise, there would one more new line in the output than in the LyX document.
 558                                 if (p != pars.end())
 559                                         xs << xml::CR();
 560                         }
 561                 } else {
 562                         for (auto const & p : pars) {
 563                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), par->layout().docbookiteminnertagtype());
 564                                 xs << XMLStream::ESCAPE_NONE << p;
 565                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 566                         }
 567                 }
 568         } else {
 569                 makeAny(text, buf, xs, runparams, par);
 570         }
 571
 572         // Close the environment.
 573         closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr); // TODO: switch in layout for par/block?
 574 }
 575
 576
 577 ParagraphList::const_iterator findEndOfEnvironment(
 578                 ParagraphList::const_iterator const & pstart,
 579                 ParagraphList::const_iterator const & pend)
 580 {
 581         // Copy-paste from XHTML. Should be factored out at some point...
 582         ParagraphList::const_iterator p = pstart;
 583         Layout const & bstyle = p->layout();
 584         size_t const depth = p->params().depth();
 585         for (++p; p != pend; ++p) {
 586                 Layout const & style = p->layout();
 587                 // It shouldn't happen that e.g. a section command occurs inside
 588                 // a quotation environment, at a higher depth, but as of 6/2009,
 589                 // it can happen. We pretend that it's just at lowest depth.
 590                 if (style.latextype == LATEX_COMMAND)
 591                         return p;
 592
 593                 // If depth is down, we're done
 594                 if (p->params().depth() < depth)
 595                         return p;
 596
 597                 // If depth is up, we're not done
 598                 if (p->params().depth() > depth)
 599                         continue;
 600
 601                 // FIXME I am not sure about the first check.
 602                 // Surely we *could* have different layouts that count as
 603                 // LATEX_PARAGRAPH, right?
 604                 if (style.latextype == LATEX_PARAGRAPH || style != bstyle)
 605                         return p;
 606         }
 607         return pend;
 608 }
 609
 610
 611 ParagraphList::const_iterator makeListEnvironment(Text const &text,
 612                                                                                                   Buffer const &buf,
 613                                                           XMLStream &xs,
 614                                                           OutputParams const &runparams,
 615                                                           ParagraphList::const_iterator const & begin)
 616 {
 617         auto par = begin;
 618         auto const end = text.paragraphs().end();
 619         auto const envend = findEndOfEnvironment(par, end);
 620
 621         // Output the opening tag for this environment.
 622         Layout const & envstyle = par->layout();
 623         openTag(xs, envstyle.docbookwrappertag(), envstyle.docbookwrapperattr(), envstyle.docbookwrappertagtype());
 624         openTag(xs, envstyle.docbooktag(), envstyle.docbookattr(), envstyle.docbooktagtype());
 625
 626         // Handle the content of the list environment, item by item.
 627         while (par != envend) {
 628                 Layout const & style = par->layout();
 629
 630                 // Open the item wrapper.
 631                 openTag(xs, style.docbookitemwrappertag(), style.docbookitemwrapperattr(), style.docbookitemwrappertagtype());
 632
 633                 // Generate the label, if need be. If it is taken from the text, sep != 0 and corresponds to the first
 634                 // character after the label.
 635                 pos_type sep = 0;
 636                 if (style.labeltype != LABEL_NO_LABEL && style.docbookitemlabeltag() != "NONE") {
 637                         if (style.labeltype == LABEL_MANUAL) {
 638                                 // Only variablelist gets here (or similar items defined as an extension in the layout).
 639                                 openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
 640                                 sep = 1 + par->firstWordDocBook(xs, runparams);
 641                                 closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
 642                         } else {
 643                                 // Usual cases: maybe there is something specified at the layout level. Highly unlikely, though.
 644                                 docstring const lbl = par->params().labelString();
 645
 646                                 if (!lbl.empty()) {
 647                                         openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
 648                                         xs << lbl;
 649                                         closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
 650                                 }
 651                         }
 652                 }
 653
 654                 // Open the item (after the wrapper and the label).
 655                 openTag(xs, style.docbookitemtag(), style.docbookitemattr(), style.docbookitemtagtype());
 656
 657                 // Generate the content of the item.
 658                 if (sep < par->size()) {
 659                         auto pars = par->simpleDocBookOnePar(buf, runparams,
 660                                                              text.outerFont(std::distance(text.paragraphs().begin(), par)), sep);
 661                         for (auto &p : pars) {
 662                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
 663                                         par->layout().docbookiteminnertagtype());
 664                                 xs << XMLStream::ESCAPE_NONE << p;
 665                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 666                         }
 667                 } else {
 668                         // DocBook doesn't like emptiness.
 669                         compTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
 670                                 par->layout().docbookiteminnertagtype());
 671                 }
 672
 673                 // If the next item is deeper, it must go entirely within this item (do it recursively).
 674                 // By construction, with findEndOfEnvironment, depth can only stay constant or increase, never decrease.
 675                 depth_type currentDepth = par->getDepth();
 676                 ++par;
 677                 while (par != envend && par->getDepth() != currentDepth)
 678                         par = makeAny(text, buf, xs, runparams, par);
 679                 // Usually, this loop only makes one iteration, except in complex scenarios, like an item with a paragraph,
 680                 // a list, and another paragraph; or an item with two types of list (itemise then enumerate, for instance).
 681
 682                 // Close the item.
 683                 closeTag(xs, style.docbookitemtag(), style.docbookitemtagtype());
 684                 closeTag(xs, style.docbookitemwrappertag(), style.docbookitemwrappertagtype());
 685         }
 686
 687         // Close this environment in exactly the same way as it was opened.
 688         closeTag(xs, envstyle.docbooktag(), envstyle.docbooktagtype());
 689         closeTag(xs, envstyle.docbookwrappertag(), envstyle.docbookwrappertagtype());
 690
 691         return envend;
 692 }
 693
 694
 695 void makeCommand(
 696                 Text const & text,
 697                 Buffer const & buf,
 698                 XMLStream & xs,
 699                 OutputParams const & runparams,
 700                 ParagraphList::const_iterator const & par)
 701 {
 702         // Unlike XHTML, no need for labels, as they are handled by DocBook tags.
 703         auto const begin = text.paragraphs().begin();
 704         auto const end = text.paragraphs().end();
 705         auto nextpar = par;
 706         ++nextpar;
 707
 708         // Generate this command.
 709         auto prevpar = text.paragraphs().getParagraphBefore(par);
 710         openParTag(xs, &*par, prevpar);
 711
 712         auto pars = par->simpleDocBookOnePar(buf, runparams,text.outerFont(distance(begin, par)));
 713         for (auto & parXML : pars)
 714                 // TODO: decide what to do with openParTag/closeParTag in new lines.
 715                 xs << XMLStream::ESCAPE_NONE << parXML;
 716
 717         closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr);
 718 }
 719
 720
 721 bool isLayoutSectioning(Layout const & lay)
 722 {
 723         if (lay.docbooksection()) // Special case: some DocBook styles must be handled as sections.
 724                 return true;
 725         else if (lay.category() == from_utf8("Sectioning")) // Generic case.
 726                 return lay.toclevel != Layout::NOT_IN_TOC;
 727         return false;
 728 }
 729
 730
 731 using DocBookDocumentSectioning = tuple<bool, pit_type>;
 732
 733
 734 struct DocBookInfoTag
 735 {
 736         const set<pit_type> shouldBeInInfo;
 737         const set<pit_type> mustBeInInfo; // With the notable exception of the abstract!
 738         const set<pit_type> abstract;
 739         const bool abstractLayout;
 740         pit_type bpit;
 741         pit_type epit;
 742
 743         DocBookInfoTag(const set<pit_type> & shouldBeInInfo, const set<pit_type> & mustBeInInfo,
 744                                    const set<pit_type> & abstract, bool abstractLayout, pit_type bpit, pit_type epit) :
 745                                    shouldBeInInfo(shouldBeInInfo), mustBeInInfo(mustBeInInfo), abstract(abstract),
 746                                    abstractLayout(abstractLayout), bpit(bpit), epit(epit) {}
 747 };
 748
 749
 750 DocBookDocumentSectioning hasDocumentSectioning(ParagraphList const &paragraphs, pit_type bpit, pit_type const epit) {
 751         bool documentHasSections = false;
 752
 753         while (bpit < epit) {
 754                 Layout const &style = paragraphs[bpit].layout();
 755                 documentHasSections |= isLayoutSectioning(style);
 756
 757                 if (documentHasSections)
 758                         break;
 759                 bpit += 1;
 760         }
 761         // Paragraphs before the first section: [ runparams.par_begin ; eppit )
 762
 763         return make_tuple(documentHasSections, bpit);
 764 }
 765
 766
 767 bool hasOnlyNotes(Paragraph const & par)
 768 {
 769         // Precondition: the paragraph is not empty. Otherwise, the function will always return true...
 770         for (int i = 0; i < par.size(); ++i)
 771                 // If you find something that is not an inset (like actual text) or an inset that is not a note,
 772                 // return false.
 773                 if (!par.isInset(i) || par.getInset(i)->lyxCode() != NOTE_CODE)
 774                         return false;
 775
 776         // An empty paragraph may still require some output.
 777         if (par.layout().docbooksection())
 778                 return false;
 779
 780         // There should be really no content here.
 781         return true;
 782 }
 783
 784
 785 DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs,
 786                                                                          pit_type bpit, pit_type const epit,
 787                                                                          // Typically, bpit is the beginning of the document and epit the end of the
 788                                                                          // document *or* the first section.
 789                                                                          bool documentHasSections,
 790                                                                          bool detectUnlayoutedAbstract
 791                                                                          // Whether paragraphs with no specific layout should be detected as abstracts.
 792                                                                          // For inner sections, an abstract should only be detected if it has a specific
 793                                                                          // layout. For others, anything that might look like an abstract should be sought.
 794                                                                          ) {
 795         set<pit_type> shouldBeInInfo;
 796         set<pit_type> mustBeInInfo;
 797         set<pit_type> abstractWithLayout;
 798         set<pit_type> abstractNoLayout;
 799
 800         // Find the first non empty paragraph by mutating bpit.
 801         while (bpit < epit) {
 802                 Paragraph const &par = paragraphs[bpit];
 803                 if (par.empty() || hasOnlyNotes(par))
 804                         bpit += 1;
 805                 else
 806                         break;
 807         }
 808
 809         // Traverse everything that might belong to <info>.
 810         bool hasAbstractLayout = false;
 811         pit_type cpit = bpit;
 812         for (; cpit < epit; ++cpit) {
 813                 // Skip paragraphs that don't generate anything in DocBook.
 814                 Paragraph const & par = paragraphs[cpit];
 815                 Layout const &style = par.layout();
 816                 if (hasOnlyNotes(par))
 817                         continue;
 818
 819                 // There should never be any section here, except for the first paragraph (a title can be part of <info>).
 820                 // (Just a sanity check: if this fails, this function could end up processing the whole document.)
 821                 if (cpit != bpit && isLayoutSectioning(par.layout())) {
 822                         LYXERR0("Assertion failed: section found in potential <info> paragraphs.");
 823                         break;
 824                 }
 825
 826                 // If this is marked as an abstract by the layout, put it in the right set.
 827                 if (style.docbookabstract()) {
 828                         hasAbstractLayout = true;
 829                         abstractWithLayout.emplace(cpit);
 830                         continue;
 831                 }
 832
 833                 // Based on layout information, store this paragraph in one set: should be in <info>, must be,
 834                 // or abstract (either because of layout or of position).
 835                 if (style.docbookininfo() == "always")
 836                         mustBeInInfo.emplace(cpit);
 837                 else if (style.docbookininfo() == "maybe")
 838                         shouldBeInInfo.emplace(cpit);
 839                 else if (documentHasSections && !hasAbstractLayout && detectUnlayoutedAbstract)
 840                         abstractNoLayout.emplace(cpit);
 841                 else // This should definitely not be in <info>.
 842                         break;
 843         }
 844         // Now, cpit points to the first paragraph that no more has things that could go in <info>.
 845         // bpit is the beginning of the <info> part.
 846
 847         return DocBookInfoTag(shouldBeInInfo, mustBeInInfo,
 848                                               hasAbstractLayout ? abstractWithLayout : abstractNoLayout,
 849                                               hasAbstractLayout, bpit, cpit);
 850 }
 851
 852 } // end anonymous namespace
 853
 854
 855 ParagraphList::const_iterator makeAny(Text const &text,
 856                                       Buffer const &buf,
 857                                       XMLStream &xs,
 858                                       OutputParams const &runparams,
 859                                       ParagraphList::const_iterator par)
 860 {
 861         switch (par->layout().latextype) {
 862         case LATEX_COMMAND:
 863                 makeCommand(text, buf, xs, runparams, par);
 864                 break;
 865         case LATEX_ENVIRONMENT:
 866                 makeEnvironment(text, buf, xs, runparams, par);
 867                 break;
 868         case LATEX_LIST_ENVIRONMENT:
 869         case LATEX_ITEM_ENVIRONMENT:
 870                 // Only case when makeAny() might consume more than one paragraph.
 871                 return makeListEnvironment(text, buf, xs, runparams, par);
 872         case LATEX_PARAGRAPH:
 873                 makeParagraph(text, buf, xs, runparams, par);
 874                 break;
 875         case LATEX_BIB_ENVIRONMENT:
 876                 makeBibliography(text, buf, xs, runparams, par);
 877                 break;
 878         }
 879         ++par;
 880         return par;
 881 }
 882
 883
 884 xml::FontTag docbookStartFontTag(xml::FontTypes type)
 885 {
 886         return xml::FontTag(from_utf8(fontToDocBookTag(type)), from_utf8(fontToAttribute(type)), type);
 887 }
 888
 889
 890 xml::EndFontTag docbookEndFontTag(xml::FontTypes type)
 891 {
 892         return xml::EndFontTag(from_utf8(fontToDocBookTag(type)), type);
 893 }
 894
 895
 896 void outputDocBookInfo(
 897                 Text const & text,
 898                 Buffer const & buf,
 899                 XMLStream & xs,
 900                 OutputParams const & runparams,
 901                 ParagraphList const & paragraphs,
 902                 DocBookInfoTag const & info)
 903 {
 904         // Perform an additional check on the abstract. Sometimes, there are many paragraphs that should go
 905         // into the abstract, but none generates actual content. Thus, first generate to a temporary stream,
 906         // then only create the <abstract> tag if these paragraphs generate some content.
 907         // This check must be performed *before* a decision on whether or not to output <info> is made.
 908         bool hasAbstract = !info.abstract.empty();
 909         docstring abstract;
 910         if (hasAbstract) {
 911                 // Generate the abstract XML into a string before further checks.
 912                 // Usually, makeAny only generates one paragraph at a time. However, for the specific case of lists, it might
 913                 // generate more than one paragraph, as indicated in the return value.
 914                 odocstringstream os2;
 915                 XMLStream xs2(os2);
 916
 917                 set<pit_type> doneParas;
 918                 for (auto const & p : info.abstract) {
 919                         if (doneParas.find(p) == doneParas.end()) {
 920                                 auto oldPar = paragraphs.iterator_at(p);
 921                                 auto newPar = makeAny(text, buf, xs2, runparams, oldPar);
 922
 923                                 // Insert the indices of all the paragraphs that were just generated (typically, one).
 924                                 // **Make the hypothesis that, when an abstract has a list, all its items are consecutive.**
 925                                 pit_type id = p;
 926                                 while (oldPar != newPar) {
 927                                         doneParas.emplace(id);
 928                                         ++oldPar;
 929                                         ++id;
 930                                 }
 931                         }
 932                 }
 933
 934                 // Actually output the abstract if there is something to do. Don't count line feeds or spaces in this,
 935                 // even though they must be properly output if there is some abstract.
 936                 abstract = os2.str();
 937                 docstring cleaned = abstract;
 938                 cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), lyx::isSpace), cleaned.end());
 939
 940                 // Nothing? Then there is no abstract!
 941                 if (cleaned.empty())
 942                         hasAbstract = false;
 943         }
 944
 945         // The abstract must go in <info>. Otherwise, decide whether to open <info> based on the layouts.
 946         bool needInfo = !info.mustBeInInfo.empty() || hasAbstract;
 947
 948         // Start the <info> tag if required.
 949         if (needInfo) {
 950                 xs.startDivision(false);
 951                 xs << xml::StartTag("info");
 952                 xs << xml::CR();
 953         }
 954
 955         // Output the elements that should go in <info>, before and after the abstract.
 956         for (auto pit : info.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
 957                 // that mandating a wrapper like <info> would repel users. Thus, generate them first.
 958                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 959         for (auto pit : info.mustBeInInfo)
 960                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 961
 962         // If there is no title, generate one (required for the document to be valid).
 963         // This code is called for the main document, for table cells, etc., so be precise in this condition.
 964         if (text.isMainText() && info.shouldBeInInfo.empty() && !runparams.inInclude) {
 965                 xs << xml::StartTag("title");
 966                 xs << "Untitled Document";
 967                 xs << xml::EndTag("title");
 968                 xs << xml::CR();
 969         }
 970
 971         // Always output the abstract as the last item of the <info>, as it requires special treatment (especially if
 972         // it contains several paragraphs that are empty).
 973         if (hasAbstract) {
 974                 if (info.abstractLayout) {
 975                         xs << XMLStream::ESCAPE_NONE << abstract;
 976                         xs << xml::CR();
 977                 } else {
 978                         string tag = paragraphs[*info.abstract.begin()].layout().docbookforceabstracttag();
 979                         if (tag == "NONE")
 980                                 tag = "abstract";
 981
 982                         if (!xs.isLastTagCR())
 983                                 xs << xml::CR();
 984
 985                         xs << xml::StartTag(tag);
 986                         xs << xml::CR();
 987                         xs << XMLStream::ESCAPE_NONE << abstract;
 988                         xs << xml::EndTag(tag);
 989                         xs << xml::CR();
 990                 }
 991         }
 992
 993         // End the <info> tag if it was started.
 994         if (needInfo) {
 995                 if (!xs.isLastTagCR())
 996                         xs << xml::CR();
 997
 998                 xs << xml::EndTag("info");
 999                 xs << xml::CR();
1000                 xs.endDivision();
1001         }
1002 }
1003
1004
1005 void docbookSimpleAllParagraphs(
1006                 Text const & text,
1007                 Buffer const & buf,
1008                 XMLStream & xs,
1009                 OutputParams const & runparams)
1010 {
1011         // Handle the given text, supposing it has no sections (i.e. a "simple" text). The input may vary in length
1012         // between a single paragraph to a whole document.
1013         pit_type const bpit = runparams.par_begin;
1014         pit_type const epit = runparams.par_end;
1015         ParagraphList const &paragraphs = text.paragraphs();
1016
1017         // First, the <info> tag.
1018         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, epit, false, true);
1019         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1020
1021         // Then, the content. It starts where the <info> ends.
1022         auto par = paragraphs.iterator_at(info.epit);
1023         auto end = paragraphs.iterator_at(epit);
1024         while (par != end) {
1025                 if (!hasOnlyNotes(*par))
1026                         par = makeAny(text, buf, xs, runparams, par);
1027                 else
1028                         ++par;
1029         }
1030 }
1031
1032
1033 void docbookParagraphs(Text const &text,
1034                                            Buffer const &buf,
1035                                            XMLStream &xs,
1036                                            OutputParams const &runparams) {
1037         ParagraphList const &paragraphs = text.paragraphs();
1038         if (runparams.par_begin == runparams.par_end) {
1039                 runparams.par_begin = 0;
1040                 runparams.par_end = paragraphs.size();
1041         }
1042         pit_type bpit = runparams.par_begin;
1043         pit_type const epit = runparams.par_end;
1044         LASSERT(bpit < epit,
1045                         {
1046                                 xs << XMLStream::ESCAPE_NONE << "<!-- DocBook output error! -->\n";
1047                                 return;
1048                         });
1049
1050         std::stack<std::pair<int, string>> headerLevels; // Used to determine when to open/close sections: store the depth
1051         // of the section and the tag that was used to open it.
1052
1053         // Detect whether the document contains sections. If there are no sections, treatment is largely simplified.
1054         // In particular, there can't be an abstract, unless it is manually marked.
1055         bool documentHasSections;
1056         pit_type eppit;
1057         tie(documentHasSections, eppit) = hasDocumentSectioning(paragraphs, bpit, epit);
1058
1059         // Deal with "simple" documents, i.e. those without sections.
1060         if (!documentHasSections) {
1061                 docbookSimpleAllParagraphs(text, buf, xs, runparams);
1062                 return;
1063         }
1064
1065         // Output the first <info> tag (or just the title).
1066         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, eppit, true, true);
1067         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1068         bpit = info.epit;
1069
1070         // Then, iterate through the paragraphs of this document.
1071         bool currentlyInAppendix = false;
1072
1073         auto par = text.paragraphs().iterator_at(bpit);
1074         auto end = text.paragraphs().iterator_at(epit);
1075         while (par != end) {
1076                 OutputParams ourparams = runparams;
1077
1078                 if (par->params().startOfAppendix())
1079                         currentlyInAppendix = true;
1080                 if (hasOnlyNotes(*par)) {
1081                         ++par;
1082                         continue;
1083                 }
1084
1085                 Layout const &style = par->layout();
1086
1087                 // Think about adding <section> and/or </section>s.
1088                 if (isLayoutSectioning(style)) {
1089                         int level = style.toclevel;
1090
1091                         // Need to close a previous section if it has the same level or a higher one (close <section> if opening a
1092                         // <h2> after a <h2>, <h3>, <h4>, <h5> or <h6>). More examples:
1093                         //   - current: h2; back: h1; do not close any <section>
1094                         //   - current: h1; back: h2; close two <section> (first the <h2>, then the <h1>, so a new <h1> can come)
1095                         while (!headerLevels.empty() && level <= headerLevels.top().first) {
1096                                 // Output the tag only if it corresponds to a legit section.
1097                                 int stackLevel = headerLevels.top().first;
1098                                 if (stackLevel != Layout::NOT_IN_TOC) {
1099                                         xs << xml::EndTag(headerLevels.top().second);
1100                                         xs << xml::CR();
1101                                 }
1102                                 headerLevels.pop();
1103                         }
1104
1105                         // Open the new section: first push it onto the stack, then output it in DocBook.
1106                         string sectionTag = (currentlyInAppendix && style.docbooksectiontag() == "chapter") ?
1107                                                                 "appendix" : style.docbooksectiontag();
1108                         headerLevels.push(std::make_pair(level, sectionTag));
1109
1110                         // Some sectioning-like elements should not be output (such as FrontMatter).
1111                         if (level != Layout::NOT_IN_TOC) {
1112                                 // Look for a label in the title, i.e. a InsetLabel as a child.
1113                                 docstring id = docstring();
1114                                 for (pos_type i = 0; i < par->size(); ++i) {
1115                                         Inset const *inset = par->getInset(i);
1116                                         if (inset) {
1117                                                 if (auto label = dynamic_cast<InsetLabel const *>(inset)) {
1118                                                         // Generate the attributes for the section if need be.
1119                                                         id += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
1120
1121                                                         // Don't output the ID as a DocBook <anchor>.
1122                                                         ourparams.docbook_anchors_to_ignore.emplace(label->screenLabel());
1123
1124                                                         // Cannot have multiple IDs per tag. If there is another ID inset in the document, it will
1125                                                         // be output as a DocBook anchor.
1126                                                         break;
1127                                                 }
1128                                         }
1129                                 }
1130
1131                                 // Write the open tag for this section.
1132                                 docstring attrs;
1133                                 if (!id.empty())
1134                                         attrs = id;
1135                                 xs << xml::StartTag(sectionTag, attrs);
1136                                 xs << xml::CR();
1137                         }
1138                 }
1139
1140                 // Close all sections before the bibliography.
1141                 // 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)?
1142                 if (!par->insetList().empty()) {
1143                         Inset const *firstInset = par->getInset(0);
1144                         if (firstInset && (firstInset->lyxCode() == BIBITEM_CODE || firstInset->lyxCode() == BIBTEX_CODE)) {
1145                                 while (!headerLevels.empty()) {
1146                                         int level = headerLevels.top().first;
1147                                         docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1148                                         headerLevels.pop();
1149
1150                                         // Output the tag only if it corresponds to a legit section.
1151                                         if (level != Layout::NOT_IN_TOC) {
1152                                                 xs << XMLStream::ESCAPE_NONE << tag;
1153                                                 xs << xml::CR();
1154                                         }
1155                                 }
1156                         }
1157                 }
1158
1159                 // Generate the <info> tag if a section was just opened.
1160                 // Some sections may require abstracts (mostly parts, in books: DocBookForceAbstractTag will not be NONE),
1161                 // others can still have an abstract (it must be detected so that it can be output at the right place).
1162                 // TODO: docbookforceabstracttag is a bit contrived here, but it does the job. Having another field just for this would be cleaner, but that's just for <part> and <partintro>, so it's probably not worth the effort.
1163                 if (isLayoutSectioning(style)) {
1164                         // This abstract may be found between the next paragraph and the next title.
1165                         pit_type cpit = std::distance(text.paragraphs().begin(), par);
1166                         pit_type ppit = std::get<1>(hasDocumentSectioning(paragraphs, cpit + 1L, epit));
1167
1168                         // Generate this abstract (this code corresponds to parts of outputDocBookInfo).
1169                         DocBookInfoTag secInfo = getParagraphsWithInfo(paragraphs, cpit, ppit, true,
1170                                                                                                   style.docbookforceabstracttag() != "NONE");
1171
1172                         if (!secInfo.mustBeInInfo.empty() || !secInfo.shouldBeInInfo.empty() || !secInfo.abstract.empty()) {
1173                                 // Generate the <info>, if required. If DocBookForceAbstractTag != NONE, this abstract will not be in
1174                                 // <info>, unlike other ("standard") abstracts.
1175                                 bool hasStandardAbstract = !secInfo.abstract.empty() && style.docbookforceabstracttag() == "NONE";
1176                                 bool needInfo = !secInfo.mustBeInInfo.empty() || hasStandardAbstract;
1177
1178                                 if (needInfo) {
1179                                         xs.startDivision(false);
1180                                         xs << xml::StartTag("info");
1181                                         xs << xml::CR();
1182                                 }
1183
1184                                 // Output the elements that should go in <info>, before and after the abstract.
1185                                 for (auto pit : secInfo.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
1186                                         // that mandating a wrapper like <info> would repel users. Thus, generate them first.
1187                                         makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(pit));
1188                                 for (auto pit : secInfo.mustBeInInfo)
1189                                         makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(pit));
1190
1191                                 // Deal with the abstract in <info> if it is standard (i.e. its tag is <abstract>).
1192                                 if (!secInfo.abstract.empty() && hasStandardAbstract) {
1193                                         if (!secInfo.abstractLayout) {
1194                                                 xs << xml::StartTag("abstract");
1195                                                 xs << xml::CR();
1196                                         }
1197
1198                                         for (auto const &p : secInfo.abstract)
1199                                                 makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(p));
1200
1201                                         if (!secInfo.abstractLayout) {
1202                                                 xs << xml::EndTag("abstract");
1203                                                 xs << xml::CR();
1204                                         }
1205                                 }
1206
1207                                 // End the <info> tag if it was started.
1208                                 if (needInfo) {
1209                                         if (!xs.isLastTagCR())
1210                                                 xs << xml::CR();
1211
1212                                         xs << xml::EndTag("info");
1213                                         xs << xml::CR();
1214                                         xs.endDivision();
1215                                 }
1216
1217                                 // Deal with the abstract outside <info> if it is not standard (i.e. its tag is layout-defined).
1218                                 if (!secInfo.abstract.empty() && !hasStandardAbstract) {
1219                                         // Assert: style.docbookforceabstracttag() != NONE.
1220                                         xs << xml::StartTag(style.docbookforceabstracttag());
1221                                         xs << xml::CR();
1222                                         for (auto const &p : secInfo.abstract)
1223                                                 makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(p));
1224                                         xs << xml::EndTag(style.docbookforceabstracttag());
1225                                         xs << xml::CR();
1226                                 }
1227
1228                                 // Skip all the text that has just been generated.
1229                                 par = paragraphs.iterator_at(secInfo.epit);
1230                         } else {
1231                                 // No <info> tag to generate, proceed as for normal paragraphs.
1232                                 par = makeAny(text, buf, xs, ourparams, par);
1233                         }
1234                 } else {
1235                         // Generate this paragraph, as it has nothing special.
1236                         par = makeAny(text, buf, xs, ourparams, par);
1237                 }
1238         }
1239
1240         // If need be, close <section>s, but only at the end of the document (otherwise, dealt with at the beginning
1241         // of the loop).
1242         while (!headerLevels.empty() && headerLevels.top().first > Layout::NOT_IN_TOC) {
1243                 docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1244                 headerLevels.pop();
1245                 xs << XMLStream::ESCAPE_NONE << tag;
1246                 xs << xml::CR();
1247         }
1248 }
1249
1250 } // namespace lyx