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>
45 ParagraphList::const_iterator searchParagraph(
46 ParagraphList::const_iterator p,
47 ParagraphList::const_iterator const & pend)
49 for (++p; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p)
56 ParagraphList::const_iterator searchCommand(
57 ParagraphList::const_iterator p,
58 ParagraphList::const_iterator const & pend)
60 LayoutPtr const & bstyle = p->layout();
62 for (++p; p != pend; ++p) {
63 LayoutPtr const & style = p->layout();
64 if (style->latextype == LATEX_COMMAND
65 && style->commanddepth <= bstyle->commanddepth)
72 ParagraphList::const_iterator searchEnvironment(
73 ParagraphList::const_iterator p,
74 ParagraphList::const_iterator const & pend)
76 LayoutPtr const & bstyle = p->layout();
77 size_t const depth = p->params().depth();
78 for (++p; p != pend; ++p) {
79 LayoutPtr const & style = p->layout();
80 if (style->latextype == LATEX_COMMAND)
83 if (style->latextype == LATEX_PARAGRAPH) {
84 if (p->params().depth() > depth)
89 if (p->params().depth() < depth)
92 if (style->latexname() != bstyle->latexname()
93 && p->params().depth() == depth)
100 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
102 OutputParams const & runparams,
103 ParagraphList const & paragraphs,
104 ParagraphList::const_iterator const & pbegin,
105 ParagraphList::const_iterator const & pend)
107 LayoutPtr const & defaultstyle =
108 buf.params().getTextClass().defaultLayout();
109 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
112 if (par->layout() == defaultstyle && par->emptyTag()) {
113 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
115 sgml::openTag(buf, os, runparams, *par);
116 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
117 sgml::closeTag(os, *par);
124 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
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;
132 LayoutPtr const & defaultstyle = buf.params().getTextClass().defaultLayout();
133 LayoutPtr const & bstyle = par->layout();
136 // Opening outter tag
137 sgml::openTag(buf, os, runparams, *pbegin);
139 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
142 while (par != pend) {
143 LayoutPtr const & style = par->layout();
144 ParagraphList::const_iterator send;
145 string id = par->getID(buf, runparams);
150 switch (bstyle->latextype) {
151 case LATEX_ENVIRONMENT:
152 if (!bstyle->innertag().empty()) {
153 sgml::openTag(os, bstyle->innertag(), id);
157 case LATEX_ITEM_ENVIRONMENT:
158 if (!bstyle->labeltag().empty()) {
159 sgml::openTag(os, bstyle->innertag(), id);
160 sgml::openTag(os, bstyle->labeltag());
161 sep = par->getFirstWord(buf, os, runparams) + 1;
162 sgml::closeTag(os, bstyle->labeltag());
164 wrapper = defaultstyle->latexname();
165 // If a sub list (embedded list) appears next with a
166 // different depth, then there is no need to open
167 // another tag at the current depth.
168 if(par->params().depth() == pbegin->params().depth()) {
169 sgml::openTag(os, bstyle->itemtag());
176 switch (style->latextype) {
177 case LATEX_ENVIRONMENT:
178 case LATEX_ITEM_ENVIRONMENT: {
179 if (par->params().depth() == pbegin->params().depth()) {
180 sgml::openTag(os, wrapper);
181 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs), sep);
182 sgml::closeTag(os, wrapper);
186 send = searchEnvironment(par, pend);
187 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
191 case LATEX_PARAGRAPH:
192 send = searchParagraph(par, pend);
193 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
200 switch (bstyle->latextype) {
201 case LATEX_ENVIRONMENT:
202 if (!bstyle->innertag().empty()) {
203 sgml::closeTag(os, bstyle->innertag());
207 case LATEX_ITEM_ENVIRONMENT:
208 // If a sub list (embedded list) appears next, then
209 // there is no need to close the current tag.
210 // par should have already been incremented to the next
211 // element. So we can compare the depth of the next
212 // element with pbegin.
213 // We need to be careful, that we don't dereference par
214 // when par == pend but at the same time that the
215 // current tag is closed.
216 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
217 sgml::closeTag(os, bstyle->itemtag());
219 if (!bstyle->labeltag().empty())
220 sgml::closeTag(os, bstyle->innertag());
227 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
230 // Closing outter tag
231 sgml::closeTag(os, *pbegin);
237 ParagraphList::const_iterator makeCommand(Buffer const & buf,
239 OutputParams const & runparams,
240 ParagraphList const & paragraphs,
241 ParagraphList::const_iterator const & pbegin,
242 ParagraphList::const_iterator const & pend)
244 ParagraphList::const_iterator par = pbegin;
245 LayoutPtr const & bstyle = par->layout();
248 sgml::openTag(buf, os, runparams, *pbegin);
251 // Label around sectioning number:
252 if (!bstyle->labeltag().empty()) {
253 sgml::openTag(os, bstyle->labeltag());
254 // We don't care about appendix in DOCBOOK.
255 os << par->expandLabel(bstyle, buf.params(), false);
256 sgml::closeTag(os, bstyle->labeltag());
259 // Opend inner tag and close inner tags
260 sgml::openTag(os, bstyle->innertag());
261 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
262 sgml::closeTag(os, bstyle->innertag());
266 while (par != pend) {
267 LayoutPtr const & style = par->layout();
268 ParagraphList::const_iterator send;
270 switch (style->latextype) {
271 case LATEX_COMMAND: {
272 send = searchCommand(par, pend);
273 par = makeCommand(buf, os, runparams, paragraphs, par,send);
276 case LATEX_ENVIRONMENT:
277 case LATEX_ITEM_ENVIRONMENT: {
278 send = searchEnvironment(par, pend);
279 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
282 case LATEX_PARAGRAPH:
283 send = searchParagraph(par, pend);
284 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
291 sgml::closeTag(os, *pbegin);
296 } // end anonym namespace
299 void docbookParagraphs(ParagraphList const & paragraphs,
302 OutputParams const & runparams)
304 ParagraphList::const_iterator par = paragraphs.begin();
305 ParagraphList::const_iterator pend = paragraphs.end();
307 BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
308 // if only part of the paragraphs will be outputed
309 if (runparams.par_begin != runparams.par_end) {
310 par = boost::next(paragraphs.begin(), runparams.par_begin);
311 pend = boost::next(paragraphs.begin(), runparams.par_end);
312 // runparams will be passed to nested paragraphs, so
313 // we have to reset the range parameters.
314 const_cast<OutputParams&>(runparams).par_begin = 0;
315 const_cast<OutputParams&>(runparams).par_end = 0;
318 while (par != pend) {
319 LayoutPtr const & style = par->layout();
320 ParagraphList::const_iterator lastpar = par;
321 ParagraphList::const_iterator send;
323 switch (style->latextype) {
324 case LATEX_COMMAND: {
325 send = searchCommand(par, pend);
326 par = makeCommand(buf, os, runparams, paragraphs, par,send);
329 case LATEX_ENVIRONMENT:
330 case LATEX_ITEM_ENVIRONMENT: {
331 send = searchEnvironment(par, pend);
332 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
335 case LATEX_PARAGRAPH:
336 send = searchParagraph(par, pend);
337 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
342 // makeEnvironment may process more than one paragraphs and bypass pend
343 if (std::distance(lastpar, par) >= std::distance(lastpar, pend))