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"
22 #include "OutputParams.h"
23 #include "Paragraph.h"
24 #include "paragraph_funcs.h"
25 #include "ParagraphList.h"
26 #include "ParagraphParameters.h"
28 #include "TextClass.h"
30 #include "support/lstrings.h"
31 #include "support/lyxlib.h"
32 #include "support/convert.h"
33 #include "support/types.h"
35 #include <boost/next_prior.hpp>
49 ParagraphList::const_iterator searchParagraph(
50 ParagraphList::const_iterator const & par,
51 ParagraphList::const_iterator const & pend)
53 ParagraphList::const_iterator p = boost::next(par);
55 for (; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p)
62 ParagraphList::const_iterator searchCommand(
63 ParagraphList::const_iterator const & par,
64 ParagraphList::const_iterator const & pend)
66 LayoutPtr const & bstyle = par->layout();
67 ParagraphList::const_iterator p = boost::next(par);
69 for ( ; p != pend; ++p) {
70 LayoutPtr const & style = p->layout();
71 if (style->latextype == LATEX_COMMAND
72 && style->commanddepth <= bstyle->commanddepth)
79 ParagraphList::const_iterator searchEnvironment(
80 ParagraphList::const_iterator const & par,
81 ParagraphList::const_iterator const & pend)
83 LayoutPtr const & bstyle = par->layout();
84 ParagraphList::const_iterator p = boost::next(par);
85 for (; p != pend; ++p) {
86 LayoutPtr const & style = p->layout();
87 if (style->latextype == LATEX_COMMAND)
90 if (style->latextype == LATEX_PARAGRAPH) {
91 if (p->params().depth() > par->params().depth())
96 if (p->params().depth() < par->params().depth())
99 if (style->latexname() != bstyle->latexname()
100 && p->params().depth() == par->params().depth() )
107 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
109 OutputParams const & runparams,
110 ParagraphList const & paragraphs,
111 ParagraphList::const_iterator const & pbegin,
112 ParagraphList::const_iterator const & pend)
114 LayoutPtr const & defaultstyle =
115 buf.params().getTextClass().defaultLayout();
116 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
119 if (par->layout() == defaultstyle && par->emptyTag()) {
120 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
122 sgml::openTag(buf, os, runparams, *par);
123 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
124 sgml::closeTag(os, *par);
131 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
133 OutputParams const & runparams,
134 ParagraphList const & paragraphs,
135 ParagraphList::const_iterator const & pbegin,
136 ParagraphList::const_iterator const & pend) {
137 ParagraphList::const_iterator par = pbegin;
139 LayoutPtr const & defaultstyle = buf.params().getTextClass().defaultLayout();
140 LayoutPtr const & bstyle = par->layout();
143 // Opening outter tag
144 sgml::openTag(buf, os, runparams, *pbegin);
146 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
149 while (par != pend) {
150 LayoutPtr const & style = par->layout();
151 ParagraphList::const_iterator send;
152 string id = par->getID(buf, runparams);
157 switch (bstyle->latextype) {
158 case LATEX_ENVIRONMENT:
159 if (!bstyle->innertag().empty()) {
160 sgml::openTag(os, bstyle->innertag(), id);
164 case LATEX_ITEM_ENVIRONMENT:
165 if (!bstyle->labeltag().empty()) {
166 sgml::openTag(os, bstyle->innertag(), id);
167 sgml::openTag(os, bstyle->labeltag());
168 sep = par->getFirstWord(buf, os, runparams) + 1;
169 sgml::closeTag(os, bstyle->labeltag());
171 wrapper = defaultstyle->latexname();
172 // If a sub list (embedded list) appears next with a
173 // different depth, then there is no need to open
174 // another tag at the current depth.
175 if(par->params().depth() == pbegin->params().depth()) {
176 sgml::openTag(os, bstyle->itemtag());
183 switch (style->latextype) {
184 case LATEX_ENVIRONMENT:
185 case LATEX_ITEM_ENVIRONMENT: {
186 if (par->params().depth() == pbegin->params().depth()) {
187 sgml::openTag(os, wrapper);
188 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs), sep);
189 sgml::closeTag(os, wrapper);
193 send = searchEnvironment(par, pend);
194 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
198 case LATEX_PARAGRAPH:
199 send = searchParagraph(par, pend);
200 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
207 switch (bstyle->latextype) {
208 case LATEX_ENVIRONMENT:
209 if (!bstyle->innertag().empty()) {
210 sgml::closeTag(os, bstyle->innertag());
214 case LATEX_ITEM_ENVIRONMENT:
215 // If a sub list (embedded list) appears next, then
216 // there is no need to close the current tag.
217 // par should have already been incremented to the next
218 // element. So we can compare the depth of the next
219 // element with pbegin.
220 // We need to be careful, that we don't dereference par
221 // when par == pend but at the same time that the
222 // current tag is closed.
223 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
224 sgml::closeTag(os, bstyle->itemtag());
226 if (!bstyle->labeltag().empty())
227 sgml::closeTag(os, bstyle->innertag());
234 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
237 // Closing outter tag
238 sgml::closeTag(os, *pbegin);
244 ParagraphList::const_iterator makeCommand(Buffer const & buf,
246 OutputParams const & runparams,
247 ParagraphList const & paragraphs,
248 ParagraphList::const_iterator const & pbegin,
249 ParagraphList::const_iterator const & pend)
251 ParagraphList::const_iterator par = pbegin;
252 LayoutPtr const & bstyle = par->layout();
255 sgml::openTag(buf, os, runparams, *pbegin);
258 // Label around sectioning number:
259 if (!bstyle->labeltag().empty()) {
260 sgml::openTag(os, bstyle->labeltag());
261 // We don't care about appendix in DOCBOOK.
262 os << par->expandLabel(bstyle, buf.params(), false);
263 sgml::closeTag(os, bstyle->labeltag());
266 // Opend inner tag and close inner tags
267 sgml::openTag(os, bstyle->innertag());
268 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
269 sgml::closeTag(os, bstyle->innertag());
273 while (par != pend) {
274 LayoutPtr const & style = par->layout();
275 ParagraphList::const_iterator send;
277 switch (style->latextype) {
278 case LATEX_COMMAND: {
279 send = searchCommand(par, pend);
280 par = makeCommand(buf, os, runparams, paragraphs, par,send);
283 case LATEX_ENVIRONMENT:
284 case LATEX_ITEM_ENVIRONMENT: {
285 send = searchEnvironment(par, pend);
286 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
289 case LATEX_PARAGRAPH:
290 send = searchParagraph(par, pend);
291 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
298 sgml::closeTag(os, *pbegin);
303 } // end anonym namespace
306 void docbookParagraphs(ParagraphList const & paragraphs,
309 OutputParams const & runparams)
311 ParagraphList::const_iterator par = paragraphs.begin();
312 ParagraphList::const_iterator pend = paragraphs.end();
314 BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
315 // if only part of the paragraphs will be outputed
316 if (runparams.par_begin != runparams.par_end) {
317 par = boost::next(paragraphs.begin(), runparams.par_begin);
318 pend = boost::next(paragraphs.begin(), runparams.par_end);
319 // runparams will be passed to nested paragraphs, so
320 // we have to reset the range parameters.
321 const_cast<OutputParams&>(runparams).par_begin = 0;
322 const_cast<OutputParams&>(runparams).par_end = 0;
325 while (par != pend) {
326 LayoutPtr const & style = par->layout();
327 ParagraphList::const_iterator lastpar = par;
328 ParagraphList::const_iterator send;
330 switch (style->latextype) {
331 case LATEX_COMMAND: {
332 send = searchCommand(par, pend);
333 par = makeCommand(buf, os, runparams, paragraphs, par,send);
336 case LATEX_ENVIRONMENT:
337 case LATEX_ITEM_ENVIRONMENT: {
338 send = searchEnvironment(par, pend);
339 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
342 case LATEX_PARAGRAPH:
343 send = searchParagraph(par, pend);
344 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
349 // makeEnvironment may process more than one paragraphs and bypass pend
350 if (std::distance(lastpar, par) >= std::distance(lastpar, pend))