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"
20 #include "support/debug.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>
38 using namespace lyx::support;
44 ParagraphList::const_iterator searchParagraph(
45 ParagraphList::const_iterator p,
46 ParagraphList::const_iterator const & pend)
48 for (++p; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p)
55 ParagraphList::const_iterator searchCommand(
56 ParagraphList::const_iterator p,
57 ParagraphList::const_iterator const & pend)
59 LayoutPtr const & bstyle = p->layout();
61 for (++p; p != pend; ++p) {
62 LayoutPtr const & style = p->layout();
63 if (style->latextype == LATEX_COMMAND
64 && style->commanddepth <= bstyle->commanddepth)
71 ParagraphList::const_iterator searchEnvironment(
72 ParagraphList::const_iterator p,
73 ParagraphList::const_iterator const & pend)
75 LayoutPtr const & bstyle = p->layout();
76 size_t const depth = p->params().depth();
77 for (++p; p != pend; ++p) {
78 LayoutPtr const & style = p->layout();
79 if (style->latextype == LATEX_COMMAND)
82 if (style->latextype == LATEX_PARAGRAPH) {
83 if (p->params().depth() > depth)
88 if (p->params().depth() < depth)
91 if (style->latexname() != bstyle->latexname()
92 && p->params().depth() == depth)
99 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
101 OutputParams const & runparams,
102 ParagraphList const & paragraphs,
103 ParagraphList::const_iterator const & pbegin,
104 ParagraphList::const_iterator const & pend)
106 LayoutPtr const & defaultstyle =
107 buf.params().getTextClass().defaultLayout();
108 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
111 if (par->layout() == defaultstyle && par->emptyTag()) {
112 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs));
114 sgml::openTag(buf, os, runparams, *par);
115 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs));
116 sgml::closeTag(os, *par);
123 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
125 OutputParams const & runparams,
126 ParagraphList const & paragraphs,
127 ParagraphList::const_iterator const & pbegin,
128 ParagraphList::const_iterator const & pend) {
129 ParagraphList::const_iterator par = pbegin;
131 LayoutPtr const & defaultstyle = buf.params().getTextClass().defaultLayout();
132 LayoutPtr const & bstyle = par->layout();
135 // Opening outter tag
136 sgml::openTag(buf, os, runparams, *pbegin);
138 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
141 while (par != pend) {
142 LayoutPtr const & style = par->layout();
143 ParagraphList::const_iterator send;
144 string id = par->getID(buf, runparams);
149 switch (bstyle->latextype) {
150 case LATEX_ENVIRONMENT:
151 if (!bstyle->innertag().empty()) {
152 sgml::openTag(os, bstyle->innertag(), id);
156 case LATEX_ITEM_ENVIRONMENT:
157 if (!bstyle->labeltag().empty()) {
158 sgml::openTag(os, bstyle->innertag(), id);
159 sgml::openTag(os, bstyle->labeltag());
160 sep = par->getFirstWord(buf, os, runparams) + 1;
161 sgml::closeTag(os, bstyle->labeltag());
163 wrapper = defaultstyle->latexname();
164 // If a sub list (embedded list) appears next with a
165 // different depth, then there is no need to open
166 // another tag at the current depth.
167 if(par->params().depth() == pbegin->params().depth()) {
168 sgml::openTag(os, bstyle->itemtag());
175 switch (style->latextype) {
176 case LATEX_ENVIRONMENT:
177 case LATEX_ITEM_ENVIRONMENT: {
178 if (par->params().depth() == pbegin->params().depth()) {
179 sgml::openTag(os, wrapper);
180 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs), sep);
181 sgml::closeTag(os, wrapper);
185 send = searchEnvironment(par, pend);
186 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
190 case LATEX_PARAGRAPH:
191 send = searchParagraph(par, pend);
192 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
199 switch (bstyle->latextype) {
200 case LATEX_ENVIRONMENT:
201 if (!bstyle->innertag().empty()) {
202 sgml::closeTag(os, bstyle->innertag());
206 case LATEX_ITEM_ENVIRONMENT:
207 // If a sub list (embedded list) appears next, then
208 // there is no need to close the current tag.
209 // par should have already been incremented to the next
210 // element. So we can compare the depth of the next
211 // element with pbegin.
212 // We need to be careful, that we don't dereference par
213 // when par == pend but at the same time that the
214 // current tag is closed.
215 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
216 sgml::closeTag(os, bstyle->itemtag());
218 if (!bstyle->labeltag().empty())
219 sgml::closeTag(os, bstyle->innertag());
226 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
229 // Closing outter tag
230 sgml::closeTag(os, *pbegin);
236 ParagraphList::const_iterator makeCommand(Buffer const & buf,
238 OutputParams const & runparams,
239 ParagraphList const & paragraphs,
240 ParagraphList::const_iterator const & pbegin,
241 ParagraphList::const_iterator const & pend)
243 ParagraphList::const_iterator par = pbegin;
244 LayoutPtr const & bstyle = par->layout();
247 sgml::openTag(buf, os, runparams, *pbegin);
250 // Label around sectioning number:
251 if (!bstyle->labeltag().empty()) {
252 sgml::openTag(os, bstyle->labeltag());
253 // We don't care about appendix in DOCBOOK.
254 os << par->expandLabel(bstyle, buf.params(), false);
255 sgml::closeTag(os, bstyle->labeltag());
258 // Opend inner tag and close inner tags
259 sgml::openTag(os, bstyle->innertag());
260 par->simpleDocBookOnePar(buf, os, runparams, outerFont(distance(paragraphs.begin(), par), paragraphs));
261 sgml::closeTag(os, bstyle->innertag());
265 while (par != pend) {
266 LayoutPtr const & style = par->layout();
267 ParagraphList::const_iterator send;
269 switch (style->latextype) {
270 case LATEX_COMMAND: {
271 send = searchCommand(par, pend);
272 par = makeCommand(buf, os, runparams, paragraphs, par,send);
275 case LATEX_ENVIRONMENT:
276 case LATEX_ITEM_ENVIRONMENT: {
277 send = searchEnvironment(par, pend);
278 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
281 case LATEX_PARAGRAPH:
282 send = searchParagraph(par, pend);
283 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
290 sgml::closeTag(os, *pbegin);
295 } // end anonym namespace
298 void docbookParagraphs(ParagraphList const & paragraphs,
301 OutputParams const & runparams)
303 ParagraphList::const_iterator par = paragraphs.begin();
304 ParagraphList::const_iterator pend = paragraphs.end();
306 BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
307 // if only part of the paragraphs will be outputed
308 if (runparams.par_begin != runparams.par_end) {
309 par = boost::next(paragraphs.begin(), runparams.par_begin);
310 pend = boost::next(paragraphs.begin(), runparams.par_end);
311 // runparams will be passed to nested paragraphs, so
312 // we have to reset the range parameters.
313 const_cast<OutputParams&>(runparams).par_begin = 0;
314 const_cast<OutputParams&>(runparams).par_end = 0;
317 while (par != pend) {
318 LayoutPtr const & style = par->layout();
319 ParagraphList::const_iterator lastpar = par;
320 ParagraphList::const_iterator send;
322 switch (style->latextype) {
323 case LATEX_COMMAND: {
324 send = searchCommand(par, pend);
325 par = makeCommand(buf, os, runparams, paragraphs, par,send);
328 case LATEX_ENVIRONMENT:
329 case LATEX_ITEM_ENVIRONMENT: {
330 send = searchEnvironment(par, pend);
331 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
334 case LATEX_PARAGRAPH:
335 send = searchParagraph(par, pend);
336 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
341 // makeEnvironment may process more than one paragraphs and bypass pend
342 if (distance(lastpar, par) >= distance(lastpar, pend))