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         string item_tag;
 140
 141         // Opening outter tag
 142         sgml::openTag(buf, os, runparams, *pbegin);
 143         os << '\n';
 144         if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
 145                 os << "<![CDATA[";
 146
 147         while (par != pend) {
 148                 Layout const & style = par->layout();
 149                 ParagraphList::const_iterator send;
 150                 string id = par->getID(buf, runparams);
 151                 string wrapper = "";
 152                 pos_type sep = 0;
 153
 154                 // Opening inner tag
 155                 switch (bstyle.latextype) {
 156                 case LATEX_ENVIRONMENT:
 157                         if (!bstyle.innertag().empty()) {
 158                                 sgml::openTag(os, bstyle.innertag(), id);
 159                         }
 160                         break;
 161
 162                 case LATEX_ITEM_ENVIRONMENT:
 163                         if (!bstyle.labeltag().empty()) {
 164                                 sgml::openTag(os, bstyle.innertag(), id);
 165                                 sgml::openTag(os, bstyle.labeltag());
 166                                 sep = par->firstWordDocBook(os, runparams) + 1;
 167                                 sgml::closeTag(os, bstyle.labeltag());
 168                         }
 169                         wrapper = defaultstyle.latexname();
 170                         // If a sub list (embedded list) appears next with a
 171                         // different depth, then there is no need to open
 172                         // another tag at the current depth.
 173                         if(par->params().depth() == pbegin->params().depth()) {
 174                                 sgml::openTag(os, bstyle.itemtag());
 175                         }
 176                         break;
 177                 default:
 178                         break;
 179                 }
 180
 181                 switch (style.latextype) {
 182                 case LATEX_ENVIRONMENT:
 183                 case LATEX_ITEM_ENVIRONMENT: {
 184                         if (par->params().depth() == pbegin->params().depth()) {
 185                                 sgml::openTag(os, wrapper);
 186                                 par->simpleDocBookOnePar(buf, os, runparams,
 187                                         text.outerFont(distance(paragraphs.begin(), par)), sep);
 188                                 sgml::closeTag(os, wrapper);
 189                                 ++par;
 190                         }
 191                         else {
 192                                 send = searchEnvironment(par, pend);
 193                                 par = makeEnvironment(buf, os, runparams, text, par,send);
 194                         }
 195                         break;
 196                 }
 197                 case LATEX_PARAGRAPH:
 198                         send = searchParagraph(par, pend);
 199                         par = makeParagraph(buf, os, runparams, text, par,send);
 200                         break;
 201                 case LATEX_LIST_ENVIRONMENT:
 202                 case LATEX_BIB_ENVIRONMENT:
 203                 case LATEX_COMMAND:
 204                         // FIXME This means that we are just skipping any paragraph that
 205                         // isn't implemented above, and this includes lists.
 206                         ++par;
 207                         break;
 208                 }
 209
 210                 // Closing inner tag
 211                 switch (bstyle.latextype) {
 212                 case LATEX_ENVIRONMENT:
 213                         if (!bstyle.innertag().empty()) {
 214                                 sgml::closeTag(os, bstyle.innertag());
 215                                 os << '\n';
 216                         }
 217                         break;
 218                 case LATEX_ITEM_ENVIRONMENT:
 219                         // If a sub list (embedded list) appears next, then
 220                         // there is no need to close the current tag.
 221                         // par should have already been incremented to the next
 222                         // element. So we can compare the depth of the next
 223                         // element with pbegin.
 224                         // We need to be careful, that we don't dereference par
 225                         // when par == pend but at the same time that the
 226                         // current tag is closed.
 227                         if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
 228                                 sgml::closeTag(os, bstyle.itemtag());
 229                         }
 230                         if (!bstyle.labeltag().empty())
 231                                 sgml::closeTag(os, bstyle.innertag());
 232                         break;
 233                 default:
 234                         break;
 235                 }
 236         }
 237
 238         if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
 239                 os << "]]>";
 240
 241         // Closing outter tag
 242         sgml::closeTag(os, *pbegin);
 243
 244         return pend;
 245 }
 246
 247
 248 ParagraphList::const_iterator makeCommand(
 249         Buffer const & buf,
 250         odocstream & os,
 251         OutputParams const & runparams,
 252         Text const & text,
 253         ParagraphList::const_iterator const & pbegin,
 254         ParagraphList::const_iterator const & pend)
 255 {
 256         ParagraphList const & paragraphs = text.paragraphs();
 257         ParagraphList::const_iterator par = pbegin;
 258         Layout const & bstyle = par->layout();
 259
 260         //Open outter tag
 261         sgml::openTag(buf, os, runparams, *pbegin);
 262         os << '\n';
 263
 264         // Label around sectioning number:
 265         if (!bstyle.labeltag().empty()) {
 266                 sgml::openTag(os, bstyle.labeltag());
 267                 // We don't care about appendix in DOCBOOK.
 268                 os << par->expandDocBookLabel(bstyle, buf.params());
 269                 sgml::closeTag(os, bstyle.labeltag());
 270         }
 271
 272         // Opend inner tag and  close inner tags
 273         sgml::openTag(os, bstyle.innertag());
 274         par->simpleDocBookOnePar(buf, os, runparams,
 275                 text.outerFont(distance(paragraphs.begin(), par)));
 276         sgml::closeTag(os, bstyle.innertag());
 277         os << '\n';
 278
 279         ++par;
 280         while (par != pend) {
 281                 Layout const & style = par->layout();
 282                 ParagraphList::const_iterator send;
 283
 284                 switch (style.latextype) {
 285                 case LATEX_COMMAND: {
 286                         send = searchCommand(par, pend);
 287                         par = makeCommand(buf, os, runparams, text, par,send);
 288                         break;
 289                 }
 290                 case LATEX_ENVIRONMENT:
 291                 case LATEX_ITEM_ENVIRONMENT: {
 292                         send = searchEnvironment(par, pend);
 293                         par = makeEnvironment(buf, os, runparams, text, par,send);
 294                         break;
 295                 }
 296                 case LATEX_PARAGRAPH:
 297                         send = searchParagraph(par, pend);
 298                         par = makeParagraph(buf, os, runparams, text, par,send);
 299                         break;
 300                 case LATEX_BIB_ENVIRONMENT:
 301                 case LATEX_LIST_ENVIRONMENT:
 302                         // FIXME This means that we are just skipping any paragraph that
 303                         // isn't implemented above.
 304                         ++par;
 305                         break;
 306                 }
 307         }
 308         // Close outter tag
 309         sgml::closeTag(os, *pbegin);
 310
 311         return pend;
 312 }
 313
 314 } // end anonym namespace
 315
 316
 317 void docbookParagraphs(Text const & text,
 318                        Buffer const & buf,
 319                        odocstream & os,
 320                        OutputParams const & runparams)
 321 {
 322         LASSERT(runparams.par_begin <= runparams.par_end,
 323                 { os << "<!-- Docbook Output Error -->\n"; return; });
 324
 325         ParagraphList const & paragraphs = text.paragraphs();
 326         ParagraphList::const_iterator par = paragraphs.begin();
 327         ParagraphList::const_iterator pend = paragraphs.end();
 328
 329         // if only part of the paragraphs will be outputed
 330         if (runparams.par_begin !=  runparams.par_end) {
 331                 par = next(paragraphs.begin(), runparams.par_begin);
 332                 pend = next(paragraphs.begin(), runparams.par_end);
 333                 // runparams will be passed to nested paragraphs, so
 334                 // we have to reset the range parameters.
 335                 const_cast<OutputParams&>(runparams).par_begin = 0;
 336                 const_cast<OutputParams&>(runparams).par_end = 0;
 337         }
 338
 339         while (par != pend) {
 340                 Layout const & style = par->layout();
 341                 ParagraphList::const_iterator lastpar = par;
 342                 ParagraphList::const_iterator send;
 343
 344                 switch (style.latextype) {
 345                 case LATEX_COMMAND: {
 346                         send = searchCommand(par, pend);
 347                         par = makeCommand(buf, os, runparams, text, par, send);
 348                         break;
 349                 }
 350                 case LATEX_ENVIRONMENT:
 351                 case LATEX_ITEM_ENVIRONMENT: {
 352                         send = searchEnvironment(par, pend);
 353                         par = makeEnvironment(buf, os, runparams, text, par, send);
 354                         break;
 355                 }
 356                 case LATEX_PARAGRAPH:
 357                         send = searchParagraph(par, pend);
 358                         par = makeParagraph(buf, os, runparams, text, par, send);
 359                         break;
 360                 case LATEX_BIB_ENVIRONMENT:
 361                 case LATEX_LIST_ENVIRONMENT:
 362                         // FIXME This means that we are just skipping any paragraph that
 363                         // isn't implemented above.
 364                         ++par;
 365                         break;
 366                 }
 367                 // makeEnvironment may process more than one paragraphs and bypass pend
 368                 if (distance(lastpar, par) >= distance(lastpar, pend))
 369                         break;
 370         }
 371 }
 372
 373
 374 } // namespace lyx