src/output_docbook.C

   1 /**
   2  * \file output_docbook.C
   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 "bufferparams.h"
  18 #include "counters.h"
  19 #include "debug.h"
  20 #include "lyxtext.h"
  21 #include "paragraph.h"
  22 #include "paragraph_funcs.h"
  23 #include "ParagraphParameters.h"
  24 #include "sgml.h"
  25
  26 #include "insets/insetcommand.h"
  27
  28 #include "support/lstrings.h"
  29 #include "support/lyxlib.h"
  30 #include "support/tostr.h"
  31
  32 #ifdef HAVE_LOCALE
  33 #endif
  34
  35 using lyx::support::subst;
  36
  37 using std::endl;
  38 using std::ostream;
  39 using std::vector;
  40 using std::string;
  41
  42 namespace {
  43
  44 ParagraphList::const_iterator searchParagraph(ParagraphList::const_iterator const & par,
  45                                               ParagraphList::const_iterator const & pend)
  46 {
  47         ParagraphList::const_iterator p = par + 1;
  48
  49         for( ; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p);
  50
  51         return p;
  52 }
  53
  54
  55 ParagraphList::const_iterator searchCommand(ParagraphList::const_iterator const & par,
  56                                             ParagraphList::const_iterator const & pend)
  57 {
  58         LyXLayout_ptr const & bstyle = par->layout();
  59         ParagraphList::const_iterator p = par + 1;
  60
  61         for( ; p != pend; ++p) {
  62                 LyXLayout_ptr const & style = p->layout();
  63                 if( style->latextype == LATEX_COMMAND && style->commanddepth <= bstyle->commanddepth)
  64                         return p;
  65         }
  66         return pend;
  67 }
  68
  69
  70 ParagraphList::const_iterator searchEnvironment(ParagraphList::const_iterator const & par,
  71                                                 ParagraphList::const_iterator const & pend)
  72 {
  73         LyXLayout_ptr const & bstyle = par->layout();
  74         ParagraphList::const_iterator p = par + 1;
  75         for( ; p != pend; ++p) {
  76                 LyXLayout_ptr 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() > par->params().depth())
  82                                 continue;
  83                         return p;
  84                 }
  85
  86                 if(p->params().depth() < par->params().depth())
  87                         return p;
  88
  89                 if( style->latexname() != bstyle->latexname() and p->params().depth() == par->params().depth() )
  90                         return p;
  91         }
  92         return pend;
  93 }
  94
  95
  96 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
  97                                             ostream & os,
  98                                             OutputParams const & runparams,
  99                                             ParagraphList const & paragraphs,
 100                                             ParagraphList::const_iterator const & pbegin,
 101                                             ParagraphList::const_iterator const & pend) {
 102         ParagraphList::const_iterator par = pbegin;
 103         Counters & counters = buf.params().getLyXTextClass().counters();
 104         const int depth = 0;
 105
 106         for(; par != pend; ++par) {
 107                 LyXLayout_ptr const & style = par->layout();
 108                 string id = par->getDocbookId();
 109
 110                 if (!style->latexparam().empty()) {
 111                         counters.step("para");
 112                         int i = counters.value("para");
 113                         id = subst(style->latexparam(), "#", tostr(i));
 114                 }
 115
 116                 id = id.empty()? "": " id = \"" + id + "\"";
 117                 sgml::openTag(os, depth, true, style->latexname(), id);
 118                 par->simpleDocBookOnePar(buf, os, outerFont(par - paragraphs.begin(), paragraphs), runparams, depth);
 119
 120                 sgml::closeTag(os, depth, true, style->latexname());
 121                 os << '\n';
 122         }
 123         return pend;
 124 }
 125
 126
 127 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
 128                                               ostream & os,
 129                                               OutputParams const & runparams,
 130                                               ParagraphList const & paragraphs,
 131                                               ParagraphList::const_iterator const & pbegin,
 132                                               ParagraphList::const_iterator const & pend) {
 133         ParagraphList::const_iterator par = pbegin;
 134
 135         Counters & counters = buf.params().getLyXTextClass().counters();
 136         LyXLayout_ptr const & defaultstyle = buf.params().getLyXTextClass().defaultLayout();
 137         const int depth = 0;
 138
 139         LyXLayout_ptr const & bstyle = par->layout();
 140         string item_tag;
 141
 142         string id = par->getDocbookId();
 143         string env_name = bstyle->latexname();
 144         // Opening outter tag
 145         sgml::openTag(os, depth, false, env_name, bstyle->latexparam() + id);
 146         os << '\n';
 147         if (bstyle->latextype == LATEX_ENVIRONMENT and bstyle->innertag() == "CDATA")
 148                 os << "<![CDATA[";
 149
 150         while (par != pend) {
 151                 LyXLayout_ptr const & style = par->layout();
 152                 string id = "";
 153                 ParagraphList::const_iterator send;
 154                 string wrapper = "";
 155
 156                 // Opening inner tag
 157                 switch (bstyle->latextype) {
 158                 case LATEX_ENVIRONMENT:
 159                         if (!bstyle->innertag().empty() and bstyle->innertag() != "CDATA") {
 160                                 sgml::openTag(os, depth, true, bstyle->innertag());
 161                         }
 162                         break;
 163
 164                 case LATEX_ITEM_ENVIRONMENT:
 165                         if (!bstyle->labeltag().empty()) {
 166                                 sgml::openTag(os, depth, true, bstyle->labeltag());
 167                         } else {
 168                                 if (!defaultstyle->latexparam().empty()) {
 169                                         counters.step("para");
 170                                         id = tostr(counters.value("para"));
 171                                         id = " id=\""+ subst(defaultstyle->latexparam(), "#", id) + '"';
 172                                 }
 173                                 wrapper = defaultstyle->latexname();
 174                                 sgml::openTag(os, depth, true, bstyle->itemtag());
 175                         }
 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, depth, true, wrapper, id);
 185                                 par->simpleDocBookOnePar(buf, os, outerFont(par - paragraphs.begin(), paragraphs), runparams, depth);
 186                                 sgml::closeTag(os, depth, true, wrapper);
 187                                 ++par;
 188                         }
 189                         else {
 190                                 send = searchEnvironment(par, pend);
 191                                 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
 192                         }
 193                         break;
 194                 }
 195                 case LATEX_PARAGRAPH:
 196                         send = searchParagraph(par, pend);
 197                         par = makeParagraph(buf, os, runparams, paragraphs, par,send);
 198                         break;
 199                 default:
 200                         break;
 201                 }
 202
 203                 // Closing inner tag
 204                 switch (bstyle->latextype) {
 205                 case LATEX_ENVIRONMENT:
 206                         if (!bstyle->innertag().empty() and bstyle->innertag() != "CDATA") {
 207                                 sgml::closeTag(os, depth, true, bstyle->innertag());
 208                                 os << '\n';
 209                         }
 210                         break;
 211                 case LATEX_ITEM_ENVIRONMENT:
 212                         sgml::closeTag(os, depth, true, bstyle->itemtag());
 213                         break;
 214                 default:
 215                         break;
 216                 }
 217         }
 218
 219         if (bstyle->latextype == LATEX_ENVIRONMENT and bstyle->innertag() == "CDATA")
 220                 os << "]]>";
 221
 222         // Closing outter tag
 223         sgml::closeTag(os, depth, false, env_name);
 224
 225         return pend;
 226 }
 227
 228
 229 ParagraphList::const_iterator makeCommand(Buffer const & buf,
 230                                           ostream & os,
 231                                           OutputParams const & runparams,
 232                                           ParagraphList const & paragraphs,
 233                                           ParagraphList::const_iterator const & pbegin,
 234                                           ParagraphList::const_iterator const & pend)
 235 {
 236         Paragraph::depth_type depth = 0; // paragraph depth
 237
 238         ParagraphList::const_iterator par = pbegin;
 239
 240         Counters & counters = buf.params().getLyXTextClass().counters();
 241         LyXLayout_ptr const & bstyle = par->layout();
 242
 243         string id = par->getDocbookId();
 244         id = id.empty()? "" : " id = \"" + id + "\"";
 245
 246         if (bstyle->latexparam().find('#') != string::npos) {
 247                 counters.step(bstyle->counter);
 248         }
 249
 250         if (!bstyle->latexparam().empty()) {
 251                 id = bstyle->latexparam();
 252                 if (id.find('#') != string::npos) {
 253                         string el = expandLabel(buf.params().getLyXTextClass(),
 254                                                 bstyle, false);
 255                         id = subst(id, "#", el);
 256                 }
 257         }
 258
 259         //Open outter tag
 260         sgml::openTag(os, depth, false, bstyle->latexname(), id);
 261         os << '\n';
 262
 263         // Label around sectioning number:
 264         if (!bstyle->labeltag().empty()) {
 265                 sgml::openTag(os, depth, false, bstyle->labeltag());
 266                 os << expandLabel(buf.params().getLyXTextClass(), bstyle, false);
 267                 sgml::closeTag(os, depth, false, bstyle->labeltag());
 268         }
 269
 270         // Opend inner tag
 271         sgml::openTag(os, depth, true, bstyle->innertag());
 272
 273         par->simpleDocBookOnePar(buf, os, outerFont(par - paragraphs.begin(), paragraphs),
 274                                  runparams, depth);
 275
 276         // Close inner tags
 277         sgml::closeTag(os, depth, true, bstyle->innertag());
 278         os << '\n';
 279
 280         ++par;
 281         while (par != pend) {
 282                 LyXLayout_ptr const & style = par->layout();
 283                 ParagraphList::const_iterator send;
 284
 285                 switch (style->latextype) {
 286                 case LATEX_COMMAND: {
 287                         send = searchCommand(par, pend);
 288                         par = makeCommand(buf, os, runparams, paragraphs, par,send);
 289                         break;
 290                 }
 291                 case LATEX_ENVIRONMENT:
 292                 case LATEX_ITEM_ENVIRONMENT: {
 293                         send = searchEnvironment(par, pend);
 294                         par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
 295                         break;
 296                 }
 297                 case LATEX_PARAGRAPH:
 298                         send = searchParagraph(par, pend);
 299                         par = makeParagraph(buf, os, runparams, paragraphs, par,send);
 300                         break;
 301                 default:
 302                         break;
 303                 }
 304         }
 305
 306         // Close outter tag
 307         sgml::closeTag(os, depth, false, bstyle->latexname());
 308
 309         return pend;
 310 }
 311
 312 } // end anonym namespace
 313
 314
 315 void docbookParagraphs(ParagraphList const & paragraphs,
 316                        Buffer const & buf,
 317                        ostream & os,
 318                        OutputParams const & runparams)
 319 {
 320         ParagraphList::const_iterator par = paragraphs.begin();
 321         ParagraphList::const_iterator pend = paragraphs.end();
 322
 323         while (par != pend) {
 324                 LyXLayout_ptr const & style = par->layout();
 325                 ParagraphList::const_iterator send;
 326
 327                 switch (style->latextype) {
 328                 case LATEX_COMMAND: {
 329                         send = searchCommand(par, pend);
 330                         par = makeCommand(buf, os, runparams, paragraphs, par,send);
 331                         break;
 332                 }
 333                 case LATEX_ENVIRONMENT:
 334                 case LATEX_ITEM_ENVIRONMENT: {
 335                         send = searchEnvironment(par, pend);
 336                         par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
 337                         break;
 338                 }
 339                 case LATEX_PARAGRAPH:
 340                         send = searchParagraph(par, pend);
 341                         par = makeParagraph(buf, os, runparams, paragraphs, par,send);
 342                         break;
 343                 default:
 344                         break;
 345                 }
 346         }
 347 }