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( style->latexname() != bstyle->latexname() and p->params().depth() <= par->params().depth())
  87                         return p;
  88         }
  89         return pend;
  90 }
  91
  92
  93 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
  94                                             ostream & os,
  95                                             OutputParams const & runparams,
  96                                             ParagraphList const & paragraphs,
  97                                             ParagraphList::const_iterator const & pbegin,
  98                                             ParagraphList::const_iterator const & pend) {
  99         ParagraphList::const_iterator par = pbegin;
 100         Counters & counters = buf.params().getLyXTextClass().counters();
 101         const int depth = 0;
 102
 103         for(; par != pend; ++par) {
 104                 LyXLayout_ptr const & style = par->layout();
 105                 string id = par->getDocbookId();
 106
 107                 if (!style->latexparam().empty()) {
 108                         counters.step("para");
 109                         int i = counters.value("para");
 110                         id = subst(style->latexparam(), "#", tostr(i));
 111                 }
 112
 113                 id = id.empty()? "": " id = \"" + id + "\"";
 114                 sgml::openTag(os, depth, true, style->latexname(), id);
 115                 par->simpleDocBookOnePar(buf, os, outerFont(par - paragraphs.begin(), paragraphs), runparams, depth);
 116
 117                 sgml::closeTag(os, depth, true, style->latexname());
 118                 os << '\n';
 119         }
 120         return pend;
 121 }
 122
 123
 124 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
 125                                               ostream & os,
 126                                               OutputParams const & runparams,
 127                                               ParagraphList const & paragraphs,
 128                                               ParagraphList::const_iterator const & pbegin,
 129                                               ParagraphList::const_iterator const & pend) {
 130         ParagraphList::const_iterator par = pbegin;
 131
 132         Counters & counters = buf.params().getLyXTextClass().counters();
 133         LyXLayout_ptr const & defaultstyle = buf.params().getLyXTextClass().defaultLayout();
 134         const int depth = 0;
 135
 136         LyXLayout_ptr const & bstyle = par->layout();
 137         string item_tag;
 138
 139         string id = par->getDocbookId();
 140         string env_name = bstyle->latexname();
 141         // Opening outter tag
 142         sgml::openTag(os, depth, false, env_name, bstyle->latexparam() + id);
 143         os << '\n';
 144         if (bstyle->latextype == LATEX_ENVIRONMENT and bstyle->innertag() == "CDATA")
 145                 os << "<![CDATA[";
 146
 147         while (par != pend) {
 148                 LyXLayout_ptr const & style = par->layout();
 149                 string id = "";
 150                 ParagraphList::const_iterator send;
 151                 string wrapper = "";
 152
 153                 // Opening inner tag
 154                 switch (bstyle->latextype) {
 155                 case LATEX_ENVIRONMENT:
 156                         if (!bstyle->innertag().empty() and bstyle->innertag() != "CDATA") {
 157                                 sgml::openTag(os, depth, true, bstyle->innertag());
 158                         }
 159                         break;
 160
 161                 case LATEX_ITEM_ENVIRONMENT:
 162                         if (!bstyle->labeltag().empty()) {
 163                                 sgml::openTag(os, depth, true, bstyle->labeltag());
 164                         } else {
 165                                 if (!defaultstyle->latexparam().empty()) {
 166                                         counters.step("para");
 167                                         id = tostr(counters.value("para"));
 168                                         id = " id=\""+ subst(defaultstyle->latexparam(), "#", id) + '"';
 169                                         wrapper = defaultstyle->latexname();
 170                                 }
 171                                 sgml::openTag(os, depth, true, bstyle->itemtag());
 172                         }
 173                 default:
 174                         break;
 175                 }
 176
 177                 switch (style->latextype) {
 178                 case LATEX_ENVIRONMENT:
 179                 case LATEX_ITEM_ENVIRONMENT: {
 180                         if(par->params().depth() == pbegin->params().depth()) {
 181                                 sgml::openTag(os, depth, true, wrapper, id);
 182                                 par->simpleDocBookOnePar(buf, os, outerFont(par - paragraphs.begin(), paragraphs), runparams, depth);
 183                                 sgml::closeTag(os, depth, true, wrapper);
 184                                 ++par;
 185                         }
 186                         else {
 187                                 send = searchEnvironment(par, pend);
 188                                 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
 189                         }
 190                         break;
 191                 }
 192                 case LATEX_PARAGRAPH:
 193                         send = searchParagraph(par, pend);
 194                         par = makeParagraph(buf, os, runparams, paragraphs, par,send);
 195                         break;
 196                 default:
 197                         break;
 198                 }
 199
 200                 // Closing inner tag
 201                 switch (bstyle->latextype) {
 202                 case LATEX_ENVIRONMENT:
 203                         if (!bstyle->innertag().empty() and bstyle->innertag() != "CDATA") {
 204                                 sgml::closeTag(os, depth, true, bstyle->innertag());
 205                                 os << '\n';
 206                         }
 207                         break;
 208                 case LATEX_ITEM_ENVIRONMENT:
 209                         sgml::closeTag(os, depth, true, bstyle->itemtag());
 210                         break;
 211                 default:
 212                         break;
 213                 }
 214         }
 215
 216         if (bstyle->latextype == LATEX_ENVIRONMENT and bstyle->innertag() == "CDATA")
 217                 os << "]]>";
 218
 219         // Closing outter tag
 220         sgml::closeTag(os, depth, false, env_name);
 221
 222         return pend;
 223 }
 224
 225
 226 ParagraphList::const_iterator makeCommand(Buffer const & buf,
 227                                           ostream & os,
 228                                           OutputParams const & runparams,
 229                                           ParagraphList const & paragraphs,
 230                                           ParagraphList::const_iterator const & pbegin,
 231                                           ParagraphList::const_iterator const & pend)
 232 {
 233         Paragraph::depth_type depth = 0; // paragraph depth
 234
 235         ParagraphList::const_iterator par = pbegin;
 236
 237         Counters & counters = buf.params().getLyXTextClass().counters();
 238         LyXLayout_ptr const & bstyle = par->layout();
 239
 240         string id = par->getDocbookId();
 241         id = id.empty()? "" : " id = \"" + id + "\"";
 242
 243         if (bstyle->latexparam().find('#') != string::npos) {
 244                 counters.step(bstyle->counter);
 245         }
 246
 247         if (!bstyle->latexparam().empty()) {
 248                 id = bstyle->latexparam();
 249                 if (id.find('#') != string::npos) {
 250                         string el = expandLabel(buf.params().getLyXTextClass(),
 251                                                 bstyle, false);
 252                         id = subst(id, "#", el);
 253                 }
 254         }
 255
 256         //Open outter tag
 257         sgml::openTag(os, depth, false, bstyle->latexname(), id);
 258         os << '\n';
 259
 260         // Label around sectioning number:
 261         if (!bstyle->labeltag().empty()) {
 262                 sgml::openTag(os, depth, false, bstyle->labeltag());
 263                 os << expandLabel(buf.params().getLyXTextClass(), bstyle, false);
 264                 sgml::closeTag(os, depth, false, bstyle->labeltag());
 265         }
 266
 267         // Opend inner tag
 268         sgml::openTag(os, depth, true, bstyle->innertag());
 269
 270         par->simpleDocBookOnePar(buf, os, outerFont(par - paragraphs.begin(), paragraphs),
 271                                  runparams, depth);
 272
 273         // Close inner tags
 274         sgml::closeTag(os, depth, true, bstyle->innertag());
 275         os << '\n';
 276
 277         ++par;
 278         while (par != pend) {
 279                 LyXLayout_ptr const & style = par->layout();
 280                 ParagraphList::const_iterator send;
 281
 282                 switch (style->latextype) {
 283                 case LATEX_COMMAND: {
 284                         send = searchCommand(par, pend);
 285                         par = makeCommand(buf, os, runparams, paragraphs, par,send);
 286                         break;
 287                 }
 288                 case LATEX_ENVIRONMENT:
 289                 case LATEX_ITEM_ENVIRONMENT: {
 290                         send = searchEnvironment(par, pend);
 291                         par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
 292                         break;
 293                 }
 294                 case LATEX_PARAGRAPH:
 295                         send = searchParagraph(par, pend);
 296                         par = makeParagraph(buf, os, runparams, paragraphs, par,send);
 297                         break;
 298                 default:
 299                         break;
 300                 }
 301         }
 302
 303         // Close outter tag
 304         sgml::closeTag(os, depth, false, bstyle->latexname());
 305
 306         return pend;
 307 }
 308
 309 } // end anonym namespace
 310
 311
 312 void docbookParagraphs(ParagraphList const & paragraphs,
 313                        Buffer const & buf,
 314                        ostream & os,
 315                        OutputParams const & runparams)
 316 {
 317         ParagraphList::const_iterator par = paragraphs.begin();
 318         ParagraphList::const_iterator pend = paragraphs.end();
 319
 320         while (par != pend) {
 321                 LyXLayout_ptr const & style = par->layout();
 322                 ParagraphList::const_iterator send;
 323
 324                 switch (style->latextype) {
 325                 case LATEX_COMMAND: {
 326                         send = searchCommand(par, pend);
 327                         par = makeCommand(buf, os, runparams, paragraphs, par,send);
 328                         break;
 329                 }
 330                 case LATEX_ENVIRONMENT:
 331                 case LATEX_ITEM_ENVIRONMENT: {
 332                         send = searchEnvironment(par, pend);
 333                         par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
 334                         break;
 335                 }
 336                 case LATEX_PARAGRAPH:
 337                         send = searchParagraph(par, pend);
 338                         par = makeParagraph(buf, os, runparams, paragraphs, par,send);
 339                         break;
 340                 default:
 341                         break;
 342                 }
 343         }
 344 }