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>
49 ParagraphList::const_iterator searchParagraph(
50 ParagraphList::const_iterator p,
51 ParagraphList::const_iterator const & pend)
53 for (++p; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p)
60 ParagraphList::const_iterator searchCommand(
61 ParagraphList::const_iterator p,
62 ParagraphList::const_iterator const & pend)
64 LayoutPtr const & bstyle = p->layout();
66 for (++p; p != pend; ++p) {
67 LayoutPtr const & style = p->layout();
68 if (style->latextype == LATEX_COMMAND
69 && style->commanddepth <= bstyle->commanddepth)
76 ParagraphList::const_iterator searchEnvironment(
77 ParagraphList::const_iterator p,
78 ParagraphList::const_iterator const & pend)
80 LayoutPtr const & bstyle = p->layout();
81 size_t const depth = p->params().depth();
82 for (++p; p != pend; ++p) {
83 LayoutPtr const & style = p->layout();
84 if (style->latextype == LATEX_COMMAND)
87 if (style->latextype == LATEX_PARAGRAPH) {
88 if (p->params().depth() > depth)
93 if (p->params().depth() < depth)
96 if (style->latexname() != bstyle->latexname()
97 && p->params().depth() == depth)
104 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
106 OutputParams const & runparams,
107 ParagraphList const & paragraphs,
108 ParagraphList::const_iterator const & pbegin,
109 ParagraphList::const_iterator const & pend)
111 LayoutPtr const & defaultstyle =
112 buf.params().getTextClass().defaultLayout();
113 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
116 if (par->layout() == defaultstyle && par->emptyTag()) {
117 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
119 sgml::openTag(buf, os, runparams, *par);
120 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
121 sgml::closeTag(os, *par);
128 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
130 OutputParams const & runparams,
131 ParagraphList const & paragraphs,
132 ParagraphList::const_iterator const & pbegin,
133 ParagraphList::const_iterator const & pend) {
134 ParagraphList::const_iterator par = pbegin;
136 LayoutPtr const & defaultstyle = buf.params().getTextClass().defaultLayout();
137 LayoutPtr const & bstyle = par->layout();
140 // Opening outter tag
141 sgml::openTag(buf, os, runparams, *pbegin);
143 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
146 while (par != pend) {
147 LayoutPtr const & style = par->layout();
148 ParagraphList::const_iterator send;
149 string id = par->getID(buf, runparams);
154 switch (bstyle->latextype) {
155 case LATEX_ENVIRONMENT:
156 if (!bstyle->innertag().empty()) {
157 sgml::openTag(os, bstyle->innertag(), id);
161 case LATEX_ITEM_ENVIRONMENT:
162 if (!bstyle->labeltag().empty()) {
163 sgml::openTag(os, bstyle->innertag(), id);
164 sgml::openTag(os, bstyle->labeltag());
165 sep = par->getFirstWord(buf, os, runparams) + 1;
166 sgml::closeTag(os, bstyle->labeltag());
168 wrapper = defaultstyle->latexname();
169 // If a sub list (embedded list) appears next with a
170 // different depth, then there is no need to open
171 // another tag at the current depth.
172 if(par->params().depth() == pbegin->params().depth()) {
173 sgml::openTag(os, bstyle->itemtag());
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, wrapper);
185 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs), sep);
186 sgml::closeTag(os, wrapper);
190 send = searchEnvironment(par, pend);
191 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
195 case LATEX_PARAGRAPH:
196 send = searchParagraph(par, pend);
197 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
204 switch (bstyle->latextype) {
205 case LATEX_ENVIRONMENT:
206 if (!bstyle->innertag().empty()) {
207 sgml::closeTag(os, bstyle->innertag());
211 case LATEX_ITEM_ENVIRONMENT:
212 // If a sub list (embedded list) appears next, then
213 // there is no need to close the current tag.
214 // par should have already been incremented to the next
215 // element. So we can compare the depth of the next
216 // element with pbegin.
217 // We need to be careful, that we don't dereference par
218 // when par == pend but at the same time that the
219 // current tag is closed.
220 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
221 sgml::closeTag(os, bstyle->itemtag());
223 if (!bstyle->labeltag().empty())
224 sgml::closeTag(os, bstyle->innertag());
231 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
234 // Closing outter tag
235 sgml::closeTag(os, *pbegin);
241 ParagraphList::const_iterator makeCommand(Buffer const & buf,
243 OutputParams const & runparams,
244 ParagraphList const & paragraphs,
245 ParagraphList::const_iterator const & pbegin,
246 ParagraphList::const_iterator const & pend)
248 ParagraphList::const_iterator par = pbegin;
249 LayoutPtr const & bstyle = par->layout();
252 sgml::openTag(buf, os, runparams, *pbegin);
255 // Label around sectioning number:
256 if (!bstyle->labeltag().empty()) {
257 sgml::openTag(os, bstyle->labeltag());
258 // We don't care about appendix in DOCBOOK.
259 os << par->expandLabel(bstyle, buf.params(), false);
260 sgml::closeTag(os, bstyle->labeltag());
263 // Opend inner tag and close inner tags
264 sgml::openTag(os, bstyle->innertag());
265 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
266 sgml::closeTag(os, bstyle->innertag());
270 while (par != pend) {
271 LayoutPtr const & style = par->layout();
272 ParagraphList::const_iterator send;
274 switch (style->latextype) {
275 case LATEX_COMMAND: {
276 send = searchCommand(par, pend);
277 par = makeCommand(buf, os, runparams, paragraphs, par,send);
280 case LATEX_ENVIRONMENT:
281 case LATEX_ITEM_ENVIRONMENT: {
282 send = searchEnvironment(par, pend);
283 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
286 case LATEX_PARAGRAPH:
287 send = searchParagraph(par, pend);
288 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
295 sgml::closeTag(os, *pbegin);
300 } // end anonym namespace
303 void docbookParagraphs(ParagraphList const & paragraphs,
306 OutputParams const & runparams)
308 ParagraphList::const_iterator par = paragraphs.begin();
309 ParagraphList::const_iterator pend = paragraphs.end();
311 BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
312 // if only part of the paragraphs will be outputed
313 if (runparams.par_begin != runparams.par_end) {
314 par = boost::next(paragraphs.begin(), runparams.par_begin);
315 pend = boost::next(paragraphs.begin(), runparams.par_end);
316 // runparams will be passed to nested paragraphs, so
317 // we have to reset the range parameters.
318 const_cast<OutputParams&>(runparams).par_begin = 0;
319 const_cast<OutputParams&>(runparams).par_end = 0;
322 while (par != pend) {
323 LayoutPtr const & style = par->layout();
324 ParagraphList::const_iterator lastpar = par;
325 ParagraphList::const_iterator send;
327 switch (style->latextype) {
328 case LATEX_COMMAND: {
329 send = searchCommand(par, pend);
330 par = makeCommand(buf, os, runparams, paragraphs, par,send);
333 case LATEX_ENVIRONMENT:
334 case LATEX_ITEM_ENVIRONMENT: {
335 send = searchEnvironment(par, pend);
336 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
339 case LATEX_PARAGRAPH:
340 send = searchParagraph(par, pend);
341 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
346 // makeEnvironment may process more than one paragraphs and bypass pend
347 if (std::distance(lastpar, par) >= std::distance(lastpar, pend))