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 bool const default_or_plain =
110 (buf.params().documentClass().isDefaultLayout(par->layout())
111 || buf.params().documentClass().isPlainLayout(par->layout()));
112 if (default_or_plain && par->emptyTag()) {
113 par->simpleDocBookOnePar(buf, os, runparams,
114 text.outerFont(distance(paragraphs.begin(), par)));
116 sgml::openTag(buf, os, runparams, *par);
117 par->simpleDocBookOnePar(buf, os, runparams,
118 text.outerFont(distance(paragraphs.begin(), par)));
119 sgml::closeTag(os, *par);
126 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
128 OutputParams const & runparams,
130 ParagraphList::const_iterator const & pbegin,
131 ParagraphList::const_iterator const & pend)
133 ParagraphList const & paragraphs = text.paragraphs();
134 ParagraphList::const_iterator par = pbegin;
136 Layout const & defaultstyle = buf.params().documentClass().defaultLayout();
137 Layout 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 Layout 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->firstWordDocBook(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,
186 text.outerFont(distance(paragraphs.begin(), par)), sep);
187 sgml::closeTag(os, wrapper);
191 send = searchEnvironment(par, pend);
192 par = makeEnvironment(buf, os, runparams, text, par,send);
196 case LATEX_PARAGRAPH:
197 send = searchParagraph(par, pend);
198 par = makeParagraph(buf, os, runparams, text, par,send);
200 case LATEX_LIST_ENVIRONMENT:
201 case LATEX_BIB_ENVIRONMENT:
203 // FIXME This means that we are just skipping any paragraph that
204 // isn't implemented above, and this includes lists.
210 switch (bstyle.latextype) {
211 case LATEX_ENVIRONMENT:
212 if (!bstyle.innertag().empty()) {
213 sgml::closeTag(os, bstyle.innertag());
217 case LATEX_ITEM_ENVIRONMENT:
218 // If a sub list (embedded list) appears next, then
219 // there is no need to close the current tag.
220 // par should have already been incremented to the next
221 // element. So we can compare the depth of the next
222 // element with pbegin.
223 // We need to be careful, that we don't dereference par
224 // when par == pend but at the same time that the
225 // current tag is closed.
226 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
227 sgml::closeTag(os, bstyle.itemtag());
229 if (!bstyle.labeltag().empty())
230 sgml::closeTag(os, bstyle.innertag());
237 if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
240 // Closing outter tag
241 sgml::closeTag(os, *pbegin);
247 ParagraphList::const_iterator makeCommand(Buffer const & buf,
249 OutputParams const & runparams,
251 ParagraphList::const_iterator const & pbegin,
252 ParagraphList::const_iterator const & pend)
254 ParagraphList const & paragraphs = text.paragraphs();
255 ParagraphList::const_iterator par = pbegin;
256 Layout const & bstyle = par->layout();
259 sgml::openTag(buf, os, runparams, *pbegin);
262 // Label around sectioning number:
263 if (!bstyle.labeltag().empty()) {
264 sgml::openTag(os, bstyle.labeltag());
265 // We don't care about appendix in DOCBOOK.
266 os << par->expandDocBookLabel(bstyle, buf.params());
267 sgml::closeTag(os, bstyle.labeltag());
270 // Opend inner tag and close inner tags
271 sgml::openTag(os, bstyle.innertag());
272 par->simpleDocBookOnePar(buf, os, runparams,
273 text.outerFont(distance(paragraphs.begin(), par)));
274 sgml::closeTag(os, bstyle.innertag());
278 while (par != pend) {
279 Layout const & style = par->layout();
280 ParagraphList::const_iterator send;
282 switch (style.latextype) {
283 case LATEX_COMMAND: {
284 send = searchCommand(par, pend);
285 par = makeCommand(buf, os, runparams, text, par,send);
288 case LATEX_ENVIRONMENT:
289 case LATEX_ITEM_ENVIRONMENT: {
290 send = searchEnvironment(par, pend);
291 par = makeEnvironment(buf, os, runparams, text, par,send);
294 case LATEX_PARAGRAPH:
295 send = searchParagraph(par, pend);
296 par = makeParagraph(buf, os, runparams, text, par,send);
303 sgml::closeTag(os, *pbegin);
308 } // end anonym namespace
311 void docbookParagraphs(Text const & text,
314 OutputParams const & runparams)
316 ParagraphList const & paragraphs = text.paragraphs();
317 ParagraphList::const_iterator par = paragraphs.begin();
318 ParagraphList::const_iterator pend = paragraphs.end();
320 LASSERT(runparams.par_begin <= runparams.par_end, /**/);
321 // if only part of the paragraphs will be outputed
322 if (runparams.par_begin != runparams.par_end) {
323 par = boost::next(paragraphs.begin(), runparams.par_begin);
324 pend = boost::next(paragraphs.begin(), runparams.par_end);
325 // runparams will be passed to nested paragraphs, so
326 // we have to reset the range parameters.
327 const_cast<OutputParams&>(runparams).par_begin = 0;
328 const_cast<OutputParams&>(runparams).par_end = 0;
331 while (par != pend) {
332 Layout const & style = par->layout();
333 ParagraphList::const_iterator lastpar = par;
334 ParagraphList::const_iterator send;
336 switch (style.latextype) {
337 case LATEX_COMMAND: {
338 send = searchCommand(par, pend);
339 par = makeCommand(buf, os, runparams, text, par, send);
342 case LATEX_ENVIRONMENT:
343 case LATEX_ITEM_ENVIRONMENT: {
344 send = searchEnvironment(par, pend);
345 par = makeEnvironment(buf, os, runparams, text, par, send);
348 case LATEX_PARAGRAPH:
349 send = searchParagraph(par, pend);
350 par = makeParagraph(buf, os, runparams, text, par, send);
355 // makeEnvironment may process more than one paragraphs and bypass pend
356 if (distance(lastpar, par) >= distance(lastpar, pend))