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 "Counters.h"
  20 #include "Font.h"
  21 #include "Layout.h"
  22 #include "OutputParams.h"
  23 #include "Paragraph.h"
  24 #include "ParagraphList.h"
  25 #include "ParagraphParameters.h"
  26 #include "sgml.h"
  27 #include "Text.h"
  28 #include "TextClass.h"
  29
  30 #include "support/lassert.h"
  31 #include "support/debug.h"
  32 #include "support/lstrings.h"
  33 #include "support/lyxalgo.h"
  34
  35 using namespace std;
  36 using namespace lyx::support;
  37
  38 namespace lyx {
  39
  40 namespace {
  41
  42 ParagraphList::const_iterator searchParagraph(
  43         ParagraphList::const_iterator p,
  44         ParagraphList::const_iterator const & pend)
  45 {
  46         for (++p; p != pend && p->layout().latextype == LATEX_PARAGRAPH; ++p)
  47                 ;
  48
  49         return p;
  50 }
  51
  52
  53 ParagraphList::const_iterator searchCommand(
  54         ParagraphList::const_iterator p,
  55         ParagraphList::const_iterator const & pend)
  56 {
  57         Layout const & bstyle = p->layout();
  58
  59         for (++p; p != pend; ++p) {
  60                 Layout const & style = p->layout();
  61                 if (style.latextype == LATEX_COMMAND
  62                                 && style.commanddepth <= bstyle.commanddepth)
  63                         return p;
  64         }
  65         return pend;
  66 }
  67
  68
  69 ParagraphList::const_iterator searchEnvironment(
  70         ParagraphList::const_iterator p,
  71         ParagraphList::const_iterator const & pend)
  72 {
  73         Layout const & bstyle = p->layout();
  74         size_t const depth = p->params().depth();
  75         for (++p; p != pend; ++p) {
  76                 Layout const & style = p->layout();
  77                 if (style.latextype == LATEX_COMMAND)
  78                         return p;
  79
  80                 if (style.latextype == LATEX_PARAGRAPH) {
  81                         if (p->params().depth() > depth)
  82                                 continue;
  83                         return p;
  84                 }
  85
  86                 if (p->params().depth() < depth)
  87                         return p;
  88
  89                 if (style.latexname() != bstyle.latexname()
  90                                 && p->params().depth() == depth)
  91                         return p;
  92         }
  93         return pend;
  94 }
  95
  96
  97 ParagraphList::const_iterator makeParagraph(
  98         Buffer const & buf,
  99         odocstream & os,
 100         OutputParams const & runparams,
 101         Text const & text,
 102         ParagraphList::const_iterator const & pbegin,
 103         ParagraphList::const_iterator const & pend)
 104 {
 105         ParagraphList const & paragraphs = text.paragraphs();
 106         for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
 107                 if (par != pbegin)
 108                         os << '\n';
 109                 bool const default_or_plain =
 110                         (buf.params().documentClass().isDefaultLayout(par->layout())
 111                                 || buf.params().documentClass().isPlainLayout(par->layout()));
 112                 if (default_or_plain && par->emptyTag()) {
 113                         par->simpleDocBookOnePar(buf, os, runparams,
 114                                         text.outerFont(distance(paragraphs.begin(), par)));
 115                 } else {
 116                         sgml::openTag(buf, os, runparams, *par);
 117                         par->simpleDocBookOnePar(buf, os, runparams,
 118                                         text.outerFont(distance(paragraphs.begin(), par)));
 119                         sgml::closeTag(os, *par);
 120                 }
 121         }
 122         return pend;
 123 }
 124
 125
 126 ParagraphList::const_iterator makeEnvironment(
 127         Buffer const & buf,
 128         odocstream & os,
 129         OutputParams const & runparams,
 130         Text const & text,
 131         ParagraphList::const_iterator const & pbegin,
 132         ParagraphList::const_iterator const & pend)
 133 {
 134         ParagraphList const & paragraphs = text.paragraphs();
 135         ParagraphList::const_iterator par = pbegin;
 136
 137         Layout const & defaultstyle = buf.params().documentClass().defaultLayout();
 138         Layout const & bstyle = par->layout();
 139
 140         // Opening outter tag
 141         sgml::openTag(buf, os, runparams, *pbegin);
 142         os << '\n';
 143         if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
 144                 os << "<![CDATA[";
 145
 146         while (par != pend) {
 147                 Layout const & style = par->layout();
 148                 ParagraphList::const_iterator send;
 149                 string id = par->getID(buf, runparams);
 150                 string wrapper = "";
 151                 pos_type sep = 0;
 152
 153                 // Opening inner tag
 154                 switch (bstyle.latextype) {
 155                 case LATEX_ENVIRONMENT:
 156                         if (!bstyle.innertag().empty()) {
 157                                 sgml::openTag(os, bstyle.innertag(), id);
 158                         }
 159                         break;
 160
 161                 case LATEX_ITEM_ENVIRONMENT:
 162                         if (!bstyle.labeltag().empty()) {
 163                                 sgml::openTag(os, bstyle.innertag(), id);
 164                                 sgml::openTag(os, bstyle.labeltag());
 165                                 sep = par->firstWordDocBook(os, runparams) + 1;
 166                                 sgml::closeTag(os, bstyle.labeltag());
 167                         }
 168                         wrapper = defaultstyle.latexname();
 169                         // If a sub list (embedded list) appears next with a
 170                         // different depth, then there is no need to open
 171                         // another tag at the current depth.
 172                         if(par->params().depth() == pbegin->params().depth()) {
 173                                 sgml::openTag(os, bstyle.itemtag());
 174                         }
 175                         break;
 176                 default:
 177                         break;
 178                 }
 179
 180                 switch (style.latextype) {
 181                 case LATEX_ENVIRONMENT:
 182                 case LATEX_ITEM_ENVIRONMENT: {
 183                         if (par->params().depth() == pbegin->params().depth()) {
 184                                 sgml::openTag(os, wrapper);
 185                                 par->simpleDocBookOnePar(buf, os, runparams,
 186                                         text.outerFont(distance(paragraphs.begin(), par)), sep);
 187                                 sgml::closeTag(os, wrapper);
 188                                 ++par;
 189                         }
 190                         else {
 191                                 send = searchEnvironment(par, pend);
 192                                 par = makeEnvironment(buf, os, runparams, text, par,send);
 193                         }
 194                         break;
 195                 }
 196                 case LATEX_PARAGRAPH:
 197                         send = searchParagraph(par, pend);
 198                         par = makeParagraph(buf, os, runparams, text, par,send);
 199                         break;
 200                 case LATEX_LIST_ENVIRONMENT:
 201                 case LATEX_BIB_ENVIRONMENT:
 202                 case LATEX_COMMAND:
 203                         // FIXME This means that we are just skipping any paragraph that
 204                         // isn't implemented above, and this includes lists.
 205                         ++par;
 206                         break;
 207                 }
 208
 209                 // Closing inner tag
 210                 switch (bstyle.latextype) {
 211                 case LATEX_ENVIRONMENT:
 212                         if (!bstyle.innertag().empty()) {
 213                                 sgml::closeTag(os, bstyle.innertag());
 214                                 os << '\n';
 215                         }
 216                         break;
 217                 case LATEX_ITEM_ENVIRONMENT:
 218                         // If a sub list (embedded list) appears next, then
 219                         // there is no need to close the current tag.
 220                         // par should have already been incremented to the next
 221                         // element. So we can compare the depth of the next
 222                         // element with pbegin.
 223                         // We need to be careful, that we don't dereference par
 224                         // when par == pend but at the same time that the
 225                         // current tag is closed.
 226                         if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
 227                                 sgml::closeTag(os, bstyle.itemtag());
 228                         }
 229                         if (!bstyle.labeltag().empty())
 230                                 sgml::closeTag(os, bstyle.innertag());
 231                         break;
 232                 default:
 233                         break;
 234                 }
 235         }
 236
 237         if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
 238                 os << "]]>";
 239
 240         // Closing outer tag
 241         sgml::closeTag(os, *pbegin);
 242
 243         return pend;
 244 }
 245
 246
 247 ParagraphList::const_iterator makeCommand(
 248         Buffer const & buf,
 249         odocstream & os,
 250         OutputParams const & runparams,
 251         Text const & text,
 252         ParagraphList::const_iterator const & pbegin,
 253         ParagraphList::const_iterator const & pend)
 254 {
 255         ParagraphList const & paragraphs = text.paragraphs();
 256         ParagraphList::const_iterator par = pbegin;
 257         Layout const & bstyle = par->layout();
 258
 259         //Open outter tag
 260         sgml::openTag(buf, os, runparams, *pbegin);
 261         os << '\n';
 262
 263         // Label around sectioning number:
 264         if (!bstyle.labeltag().empty()) {
 265                 sgml::openTag(os, bstyle.labeltag());
 266                 // We don't care about appendix in DOCBOOK.
 267                 os << par->expandDocBookLabel(bstyle, buf.params());
 268                 sgml::closeTag(os, bstyle.labeltag());
 269         }
 270
 271         // Opend inner tag and  close inner tags
 272         sgml::openTag(os, bstyle.innertag());
 273         par->simpleDocBookOnePar(buf, os, runparams,
 274                 text.outerFont(distance(paragraphs.begin(), par)));
 275         sgml::closeTag(os, bstyle.innertag());
 276         os << '\n';
 277
 278         ++par;
 279         while (par != pend) {
 280                 Layout const & style = par->layout();
 281                 ParagraphList::const_iterator send;
 282
 283                 switch (style.latextype) {
 284                 case LATEX_COMMAND: {
 285                         send = searchCommand(par, pend);
 286                         par = makeCommand(buf, os, runparams, text, par,send);
 287                         break;
 288                 }
 289                 case LATEX_ENVIRONMENT:
 290                 case LATEX_ITEM_ENVIRONMENT: {
 291                         send = searchEnvironment(par, pend);
 292                         par = makeEnvironment(buf, os, runparams, text, par,send);
 293                         break;
 294                 }
 295                 case LATEX_PARAGRAPH:
 296                         send = searchParagraph(par, pend);
 297                         par = makeParagraph(buf, os, runparams, text, par,send);
 298                         break;
 299                 case LATEX_BIB_ENVIRONMENT:
 300                 case LATEX_LIST_ENVIRONMENT:
 301                         // FIXME This means that we are just skipping any paragraph that
 302                         // isn't implemented above.
 303                         ++par;
 304                         break;
 305                 }
 306         }
 307         // Close outter tag
 308         sgml::closeTag(os, *pbegin);
 309
 310         return pend;
 311 }
 312
 313 } // end anonym namespace
 314
 315
 316 void docbookParagraphs(Text const & text,
 317                        Buffer const & buf,
 318                        odocstream & os,
 319                        OutputParams const & runparams)
 320 {
 321         LASSERT(runparams.par_begin <= runparams.par_end,
 322                 { os << "<!-- Docbook Output Error -->\n"; return; });
 323
 324         ParagraphList const & paragraphs = text.paragraphs();
 325         ParagraphList::const_iterator par = paragraphs.begin();
 326         ParagraphList::const_iterator pend = paragraphs.end();
 327
 328         // if only part of the paragraphs will be outputed
 329         if (runparams.par_begin !=  runparams.par_end) {
 330                 par = lyx::next(paragraphs.begin(), runparams.par_begin);
 331                 pend = lyx::next(paragraphs.begin(), runparams.par_end);
 332                 // runparams will be passed to nested paragraphs, so
 333                 // we have to reset the range parameters.
 334                 const_cast<OutputParams&>(runparams).par_begin = 0;
 335                 const_cast<OutputParams&>(runparams).par_end = 0;
 336         }
 337
 338         while (par != pend) {
 339                 Layout const & style = par->layout();
 340                 ParagraphList::const_iterator lastpar = par;
 341                 ParagraphList::const_iterator send;
 342
 343                 switch (style.latextype) {
 344                 case LATEX_COMMAND: {
 345                         send = searchCommand(par, pend);
 346                         par = makeCommand(buf, os, runparams, text, par, send);
 347                         break;
 348                 }
 349                 case LATEX_ENVIRONMENT:
 350                 case LATEX_ITEM_ENVIRONMENT: {
 351                         send = searchEnvironment(par, pend);
 352                         par = makeEnvironment(buf, os, runparams, text, par, send);
 353                         break;
 354                 }
 355                 case LATEX_PARAGRAPH:
 356                         send = searchParagraph(par, pend);
 357                         par = makeParagraph(buf, os, runparams, text, par, send);
 358                         break;
 359                 case LATEX_BIB_ENVIRONMENT:
 360                 case LATEX_LIST_ENVIRONMENT:
 361                         // FIXME This means that we are just skipping any paragraph that
 362                         // isn't implemented above.
 363                         ++par;
 364                         break;
 365                 }
 366                 // makeEnvironment may process more than one paragraphs and bypass pend
 367                 if (distance(lastpar, par) >= distance(lastpar, pend))
 368                         break;
 369         }
 370 }
 371
 372
 373 } // namespace lyx