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 "ParagraphList.h"
25 #include "ParagraphParameters.h"
28 #include "TextClass.h"
30 #include "support/lassert.h"
31 #include "support/debug.h"
32 #include "support/lstrings.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 Layout const & bstyle = p->layout();
60 for (++p; p != pend; ++p) {
61 Layout 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 Layout const & bstyle = p->layout();
75 size_t const depth = p->params().depth();
76 for (++p; p != pend; ++p) {
77 Layout 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,
102 ParagraphList::const_iterator const & pbegin,
103 ParagraphList::const_iterator const & pend)
105 ParagraphList const & paragraphs = text.paragraphs();
106 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
109 if (buf.params().documentClass().isDefaultLayout(par->layout())
110 && par->emptyTag()) {
111 par->simpleDocBookOnePar(buf, os, runparams,
112 text.outerFont(distance(paragraphs.begin(), par)));
114 sgml::openTag(buf, os, runparams, *par);
115 par->simpleDocBookOnePar(buf, os, runparams,
116 text.outerFont(distance(paragraphs.begin(), par)));
117 sgml::closeTag(os, *par);
124 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
126 OutputParams const & runparams,
128 ParagraphList::const_iterator const & pbegin,
129 ParagraphList::const_iterator const & pend)
131 ParagraphList const & paragraphs = text.paragraphs();
132 ParagraphList::const_iterator par = pbegin;
134 Layout const & defaultstyle = buf.params().documentClass().defaultLayout();
135 Layout const & bstyle = par->layout();
138 // Opening outter tag
139 sgml::openTag(buf, os, runparams, *pbegin);
141 if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
144 while (par != pend) {
145 Layout const & style = par->layout();
146 ParagraphList::const_iterator send;
147 string id = par->getID(buf, runparams);
152 switch (bstyle.latextype) {
153 case LATEX_ENVIRONMENT:
154 if (!bstyle.innertag().empty()) {
155 sgml::openTag(os, bstyle.innertag(), id);
159 case LATEX_ITEM_ENVIRONMENT:
160 if (!bstyle.labeltag().empty()) {
161 sgml::openTag(os, bstyle.innertag(), id);
162 sgml::openTag(os, bstyle.labeltag());
163 sep = par->firstWordDocBook(os, runparams) + 1;
164 sgml::closeTag(os, bstyle.labeltag());
166 wrapper = defaultstyle.latexname();
167 // If a sub list (embedded list) appears next with a
168 // different depth, then there is no need to open
169 // another tag at the current depth.
170 if(par->params().depth() == pbegin->params().depth()) {
171 sgml::openTag(os, bstyle.itemtag());
178 switch (style.latextype) {
179 case LATEX_ENVIRONMENT:
180 case LATEX_ITEM_ENVIRONMENT: {
181 if (par->params().depth() == pbegin->params().depth()) {
182 sgml::openTag(os, wrapper);
183 par->simpleDocBookOnePar(buf, os, runparams,
184 text.outerFont(distance(paragraphs.begin(), par)), sep);
185 sgml::closeTag(os, wrapper);
189 send = searchEnvironment(par, pend);
190 par = makeEnvironment(buf, os, runparams, text, par,send);
194 case LATEX_PARAGRAPH:
195 send = searchParagraph(par, pend);
196 par = makeParagraph(buf, os, runparams, text, par,send);
198 case LATEX_LIST_ENVIRONMENT:
199 case LATEX_BIB_ENVIRONMENT:
201 // FIXME This means that we are just skipping any paragraph that
202 // isn't implemented above, and this includes lists.
208 switch (bstyle.latextype) {
209 case LATEX_ENVIRONMENT:
210 if (!bstyle.innertag().empty()) {
211 sgml::closeTag(os, bstyle.innertag());
215 case LATEX_ITEM_ENVIRONMENT:
216 // If a sub list (embedded list) appears next, then
217 // there is no need to close the current tag.
218 // par should have already been incremented to the next
219 // element. So we can compare the depth of the next
220 // element with pbegin.
221 // We need to be careful, that we don't dereference par
222 // when par == pend but at the same time that the
223 // current tag is closed.
224 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
225 sgml::closeTag(os, bstyle.itemtag());
227 if (!bstyle.labeltag().empty())
228 sgml::closeTag(os, bstyle.innertag());
235 if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
238 // Closing outter tag
239 sgml::closeTag(os, *pbegin);
245 ParagraphList::const_iterator makeCommand(Buffer const & buf,
247 OutputParams const & runparams,
249 ParagraphList::const_iterator const & pbegin,
250 ParagraphList::const_iterator const & pend)
252 ParagraphList const & paragraphs = text.paragraphs();
253 ParagraphList::const_iterator par = pbegin;
254 Layout const & bstyle = par->layout();
257 sgml::openTag(buf, os, runparams, *pbegin);
260 // Label around sectioning number:
261 if (!bstyle.labeltag().empty()) {
262 sgml::openTag(os, bstyle.labeltag());
263 // We don't care about appendix in DOCBOOK.
264 os << par->expandDocBookLabel(bstyle, buf.params());
265 sgml::closeTag(os, bstyle.labeltag());
268 // Opend inner tag and close inner tags
269 sgml::openTag(os, bstyle.innertag());
270 par->simpleDocBookOnePar(buf, os, runparams,
271 text.outerFont(distance(paragraphs.begin(), par)));
272 sgml::closeTag(os, bstyle.innertag());
276 while (par != pend) {
277 Layout const & style = par->layout();
278 ParagraphList::const_iterator send;
280 switch (style.latextype) {
281 case LATEX_COMMAND: {
282 send = searchCommand(par, pend);
283 par = makeCommand(buf, os, runparams, text, par,send);
286 case LATEX_ENVIRONMENT:
287 case LATEX_ITEM_ENVIRONMENT: {
288 send = searchEnvironment(par, pend);
289 par = makeEnvironment(buf, os, runparams, text, par,send);
292 case LATEX_PARAGRAPH:
293 send = searchParagraph(par, pend);
294 par = makeParagraph(buf, os, runparams, text, par,send);
301 sgml::closeTag(os, *pbegin);
306 } // end anonym namespace
309 void docbookParagraphs(Text const & text,
312 OutputParams const & runparams)
314 ParagraphList const & paragraphs = text.paragraphs();
315 ParagraphList::const_iterator par = paragraphs.begin();
316 ParagraphList::const_iterator pend = paragraphs.end();
318 LASSERT(runparams.par_begin <= runparams.par_end, /**/);
319 // if only part of the paragraphs will be outputed
320 if (runparams.par_begin != runparams.par_end) {
321 par = boost::next(paragraphs.begin(), runparams.par_begin);
322 pend = boost::next(paragraphs.begin(), runparams.par_end);
323 // runparams will be passed to nested paragraphs, so
324 // we have to reset the range parameters.
325 const_cast<OutputParams&>(runparams).par_begin = 0;
326 const_cast<OutputParams&>(runparams).par_end = 0;
329 while (par != pend) {
330 Layout const & style = par->layout();
331 ParagraphList::const_iterator lastpar = par;
332 ParagraphList::const_iterator send;
334 switch (style.latextype) {
335 case LATEX_COMMAND: {
336 send = searchCommand(par, pend);
337 par = makeCommand(buf, os, runparams, text, par,send);
340 case LATEX_ENVIRONMENT:
341 case LATEX_ITEM_ENVIRONMENT: {
342 send = searchEnvironment(par, pend);
343 par = makeEnvironment(buf, os, runparams, text, par,send);
346 case LATEX_PARAGRAPH:
347 send = searchParagraph(par, pend);
348 par = makeParagraph(buf, os, runparams, text, par,send);
353 // makeEnvironment may process more than one paragraphs and bypass pend
354 if (distance(lastpar, par) >= distance(lastpar, pend))