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.
6 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
14 #include "output_docbook.h"
17 #include "buffer_funcs.h"
18 #include "BufferParams.h"
21 #include "OutputParams.h"
22 #include "Paragraph.h"
23 #include "paragraph_funcs.h"
24 #include "ParagraphList.h"
25 #include "ParagraphParameters.h"
27 #include "TextClass.h"
29 #include "support/convert.h"
30 #include "support/debug.h"
31 #include "support/lstrings.h"
32 #include "support/types.h"
34 #include <boost/next_prior.hpp>
37 using namespace lyx::support;
43 ParagraphList::const_iterator searchParagraph(
44 ParagraphList::const_iterator p,
45 ParagraphList::const_iterator const & pend)
47 for (++p; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p)
54 ParagraphList::const_iterator searchCommand(
55 ParagraphList::const_iterator p,
56 ParagraphList::const_iterator const & pend)
58 LayoutPtr const & bstyle = p->layout();
60 for (++p; p != pend; ++p) {
61 LayoutPtr const & style = p->layout();
62 if (style->latextype == LATEX_COMMAND
63 && style->commanddepth <= bstyle->commanddepth)
70 ParagraphList::const_iterator searchEnvironment(
71 ParagraphList::const_iterator p,
72 ParagraphList::const_iterator const & pend)
74 LayoutPtr const & bstyle = p->layout();
75 size_t const depth = p->params().depth();
76 for (++p; p != pend; ++p) {
77 LayoutPtr const & style = p->layout();
78 if (style->latextype == LATEX_COMMAND)
81 if (style->latextype == LATEX_PARAGRAPH) {
82 if (p->params().depth() > depth)
87 if (p->params().depth() < depth)
90 if (style->latexname() != bstyle->latexname()
91 && p->params().depth() == depth)
98 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
100 OutputParams const & runparams,
101 ParagraphList const & paragraphs,
102 ParagraphList::const_iterator const & pbegin,
103 ParagraphList::const_iterator const & pend)
105 LayoutPtr const & defaultstyle = buf.params().textClass().defaultLayout();
106 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
109 if (par->layout() == defaultstyle && par->emptyTag()) {
110 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs));
112 sgml::openTag(buf, os, runparams, *par);
113 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs));
114 sgml::closeTag(os, *par);
121 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
123 OutputParams const & runparams,
124 ParagraphList const & paragraphs,
125 ParagraphList::const_iterator const & pbegin,
126 ParagraphList::const_iterator const & pend) {
127 ParagraphList::const_iterator par = pbegin;
129 LayoutPtr const & defaultstyle = buf.params().textClass().defaultLayout();
130 LayoutPtr const & bstyle = par->layout();
133 // Opening outter tag
134 sgml::openTag(buf, os, runparams, *pbegin);
136 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
139 while (par != pend) {
140 LayoutPtr const & style = par->layout();
141 ParagraphList::const_iterator send;
142 string id = par->getID(buf, runparams);
147 switch (bstyle->latextype) {
148 case LATEX_ENVIRONMENT:
149 if (!bstyle->innertag().empty()) {
150 sgml::openTag(os, bstyle->innertag(), id);
154 case LATEX_ITEM_ENVIRONMENT:
155 if (!bstyle->labeltag().empty()) {
156 sgml::openTag(os, bstyle->innertag(), id);
157 sgml::openTag(os, bstyle->labeltag());
158 sep = par->getFirstWord(buf, os, runparams) + 1;
159 sgml::closeTag(os, bstyle->labeltag());
161 wrapper = defaultstyle->latexname();
162 // If a sub list (embedded list) appears next with a
163 // different depth, then there is no need to open
164 // another tag at the current depth.
165 if(par->params().depth() == pbegin->params().depth()) {
166 sgml::openTag(os, bstyle->itemtag());
173 switch (style->latextype) {
174 case LATEX_ENVIRONMENT:
175 case LATEX_ITEM_ENVIRONMENT: {
176 if (par->params().depth() == pbegin->params().depth()) {
177 sgml::openTag(os, wrapper);
178 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs), sep);
179 sgml::closeTag(os, wrapper);
183 send = searchEnvironment(par, pend);
184 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
188 case LATEX_PARAGRAPH:
189 send = searchParagraph(par, pend);
190 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
197 switch (bstyle->latextype) {
198 case LATEX_ENVIRONMENT:
199 if (!bstyle->innertag().empty()) {
200 sgml::closeTag(os, bstyle->innertag());
204 case LATEX_ITEM_ENVIRONMENT:
205 // If a sub list (embedded list) appears next, then
206 // there is no need to close the current tag.
207 // par should have already been incremented to the next
208 // element. So we can compare the depth of the next
209 // element with pbegin.
210 // We need to be careful, that we don't dereference par
211 // when par == pend but at the same time that the
212 // current tag is closed.
213 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
214 sgml::closeTag(os, bstyle->itemtag());
216 if (!bstyle->labeltag().empty())
217 sgml::closeTag(os, bstyle->innertag());
224 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
227 // Closing outter tag
228 sgml::closeTag(os, *pbegin);
234 ParagraphList::const_iterator makeCommand(Buffer const & buf,
236 OutputParams const & runparams,
237 ParagraphList const & paragraphs,
238 ParagraphList::const_iterator const & pbegin,
239 ParagraphList::const_iterator const & pend)
241 ParagraphList::const_iterator par = pbegin;
242 LayoutPtr const & bstyle = par->layout();
245 sgml::openTag(buf, os, runparams, *pbegin);
248 // Label around sectioning number:
249 if (!bstyle->labeltag().empty()) {
250 sgml::openTag(os, bstyle->labeltag());
251 // We don't care about appendix in DOCBOOK.
252 os << par->expandLabel(bstyle, buf.params(), false);
253 sgml::closeTag(os, bstyle->labeltag());
256 // Opend inner tag and close inner tags
257 sgml::openTag(os, bstyle->innertag());
258 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs));
259 sgml::closeTag(os, bstyle->innertag());
263 while (par != pend) {
264 LayoutPtr const & style = par->layout();
265 ParagraphList::const_iterator send;
267 switch (style->latextype) {
268 case LATEX_COMMAND: {
269 send = searchCommand(par, pend);
270 par = makeCommand(buf, os, runparams, paragraphs, par,send);
273 case LATEX_ENVIRONMENT:
274 case LATEX_ITEM_ENVIRONMENT: {
275 send = searchEnvironment(par, pend);
276 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
279 case LATEX_PARAGRAPH:
280 send = searchParagraph(par, pend);
281 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
288 sgml::closeTag(os, *pbegin);
293 } // end anonym namespace
296 void docbookParagraphs(ParagraphList const & paragraphs,
299 OutputParams const & runparams)
301 ParagraphList::const_iterator par = paragraphs.begin();
302 ParagraphList::const_iterator pend = paragraphs.end();
304 BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
305 // if only part of the paragraphs will be outputed
306 if (runparams.par_begin != runparams.par_end) {
307 par = boost::next(paragraphs.begin(), runparams.par_begin);
308 pend = boost::next(paragraphs.begin(), runparams.par_end);
309 // runparams will be passed to nested paragraphs, so
310 // we have to reset the range parameters.
311 const_cast<OutputParams&>(runparams).par_begin = 0;
312 const_cast<OutputParams&>(runparams).par_end = 0;
315 while (par != pend) {
316 LayoutPtr const & style = par->layout();
317 ParagraphList::const_iterator lastpar = par;
318 ParagraphList::const_iterator send;
320 switch (style->latextype) {
321 case LATEX_COMMAND: {
322 send = searchCommand(par, pend);
323 par = makeCommand(buf, os, runparams, paragraphs, par,send);
326 case LATEX_ENVIRONMENT:
327 case LATEX_ITEM_ENVIRONMENT: {
328 send = searchEnvironment(par, pend);
329 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
332 case LATEX_PARAGRAPH:
333 send = searchParagraph(par, pend);
334 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
339 // makeEnvironment may process more than one paragraphs and bypass pend
340 if (distance(lastpar, par) >= distance(lastpar, pend))