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"
19 #include "OutputParams.h"
22 #include "Paragraph.h"
23 #include "paragraph_funcs.h"
24 #include "ParagraphList.h"
25 #include "ParagraphParameters.h"
28 #include "insets/InsetCommand.h"
30 #include "support/lstrings.h"
31 #include "support/lyxlib.h"
32 #include "support/convert.h"
33 #include "support/types.h"
47 ParagraphList::const_iterator searchParagraph(
48 ParagraphList::const_iterator const & par,
49 ParagraphList::const_iterator const & pend)
51 ParagraphList::const_iterator p = boost::next(par);
53 for (; p != pend && p->layout()->latextype == LATEX_PARAGRAPH; ++p)
60 ParagraphList::const_iterator searchCommand(
61 ParagraphList::const_iterator const & par,
62 ParagraphList::const_iterator const & pend)
64 LayoutPtr const & bstyle = par->layout();
65 ParagraphList::const_iterator p = boost::next(par);
67 for ( ; p != pend; ++p) {
68 LayoutPtr const & style = p->layout();
69 if (style->latextype == LATEX_COMMAND
70 && style->commanddepth <= bstyle->commanddepth)
77 ParagraphList::const_iterator searchEnvironment(
78 ParagraphList::const_iterator const & par,
79 ParagraphList::const_iterator const & pend)
81 LayoutPtr const & bstyle = par->layout();
82 ParagraphList::const_iterator p = boost::next(par);
83 for (; p != pend; ++p) {
84 LayoutPtr const & style = p->layout();
85 if (style->latextype == LATEX_COMMAND)
88 if (style->latextype == LATEX_PARAGRAPH) {
89 if (p->params().depth() > par->params().depth())
94 if (p->params().depth() < par->params().depth())
97 if (style->latexname() != bstyle->latexname()
98 && p->params().depth() == par->params().depth() )
105 ParagraphList::const_iterator makeParagraph(Buffer const & buf,
107 OutputParams const & runparams,
108 ParagraphList const & paragraphs,
109 ParagraphList::const_iterator const & pbegin,
110 ParagraphList::const_iterator const & pend)
112 LayoutPtr const & defaultstyle =
113 buf.params().getTextClass().defaultLayout();
114 for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
117 if (par->layout() == defaultstyle && par->emptyTag()) {
118 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
120 sgml::openTag(buf, os, runparams, *par);
121 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
122 sgml::closeTag(os, *par);
129 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
131 OutputParams const & runparams,
132 ParagraphList const & paragraphs,
133 ParagraphList::const_iterator const & pbegin,
134 ParagraphList::const_iterator const & pend) {
135 ParagraphList::const_iterator par = pbegin;
137 LayoutPtr const & defaultstyle = buf.params().getTextClass().defaultLayout();
138 LayoutPtr const & bstyle = par->layout();
141 // Opening outter tag
142 sgml::openTag(buf, os, runparams, *pbegin);
144 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
147 while (par != pend) {
148 LayoutPtr const & style = par->layout();
149 ParagraphList::const_iterator send;
150 string id = par->getID(buf, runparams);
155 switch (bstyle->latextype) {
156 case LATEX_ENVIRONMENT:
157 if (!bstyle->innertag().empty()) {
158 sgml::openTag(os, bstyle->innertag(), id);
162 case LATEX_ITEM_ENVIRONMENT:
163 if (!bstyle->labeltag().empty()) {
164 sgml::openTag(os, bstyle->innertag(), id);
165 sgml::openTag(os, bstyle->labeltag());
166 sep = par->getFirstWord(buf, os, runparams) + 1;
167 sgml::closeTag(os, bstyle->labeltag());
169 wrapper = defaultstyle->latexname();
170 // If a sub list (embedded list) appears next with a
171 // different depth, then there is no need to open
172 // another tag at the current depth.
173 if(par->params().depth() == pbegin->params().depth()) {
174 sgml::openTag(os, bstyle->itemtag());
181 switch (style->latextype) {
182 case LATEX_ENVIRONMENT:
183 case LATEX_ITEM_ENVIRONMENT: {
184 if (par->params().depth() == pbegin->params().depth()) {
185 sgml::openTag(os, wrapper);
186 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs), sep);
187 sgml::closeTag(os, wrapper);
191 send = searchEnvironment(par, pend);
192 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
196 case LATEX_PARAGRAPH:
197 send = searchParagraph(par, pend);
198 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
205 switch (bstyle->latextype) {
206 case LATEX_ENVIRONMENT:
207 if (!bstyle->innertag().empty()) {
208 sgml::closeTag(os, bstyle->innertag());
212 case LATEX_ITEM_ENVIRONMENT:
213 // If a sub list (embedded list) appears next, then
214 // there is no need to close the current tag.
215 // par should have already been incremented to the next
216 // element. So we can compare the depth of the next
217 // element with pbegin.
218 // We need to be careful, that we don't dereference par
219 // when par == pend but at the same time that the
220 // current tag is closed.
221 if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
222 sgml::closeTag(os, bstyle->itemtag());
224 if (!bstyle->labeltag().empty())
225 sgml::closeTag(os, bstyle->innertag());
232 if (bstyle->latextype == LATEX_ENVIRONMENT && bstyle->pass_thru)
235 // Closing outter tag
236 sgml::closeTag(os, *pbegin);
242 ParagraphList::const_iterator makeCommand(Buffer const & buf,
244 OutputParams const & runparams,
245 ParagraphList const & paragraphs,
246 ParagraphList::const_iterator const & pbegin,
247 ParagraphList::const_iterator const & pend)
249 ParagraphList::const_iterator par = pbegin;
250 LayoutPtr const & bstyle = par->layout();
253 sgml::openTag(buf, os, runparams, *pbegin);
256 // Label around sectioning number:
257 if (!bstyle->labeltag().empty()) {
258 sgml::openTag(os, bstyle->labeltag());
259 // We don't care about appendix in DOCBOOK.
260 os << par->expandLabel(bstyle, buf.params(), false);
261 sgml::closeTag(os, bstyle->labeltag());
264 // Opend inner tag and close inner tags
265 sgml::openTag(os, bstyle->innertag());
266 par->simpleDocBookOnePar(buf, os, runparams, outerFont(std::distance(paragraphs.begin(), par), paragraphs));
267 sgml::closeTag(os, bstyle->innertag());
271 while (par != pend) {
272 LayoutPtr const & style = par->layout();
273 ParagraphList::const_iterator send;
275 switch (style->latextype) {
276 case LATEX_COMMAND: {
277 send = searchCommand(par, pend);
278 par = makeCommand(buf, os, runparams, paragraphs, par,send);
281 case LATEX_ENVIRONMENT:
282 case LATEX_ITEM_ENVIRONMENT: {
283 send = searchEnvironment(par, pend);
284 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
287 case LATEX_PARAGRAPH:
288 send = searchParagraph(par, pend);
289 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
296 sgml::closeTag(os, *pbegin);
301 } // end anonym namespace
304 void docbookParagraphs(ParagraphList const & paragraphs,
307 OutputParams const & runparams)
309 ParagraphList::const_iterator par = paragraphs.begin();
310 ParagraphList::const_iterator pend = paragraphs.end();
312 BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
313 // if only part of the paragraphs will be outputed
314 if (runparams.par_begin != runparams.par_end) {
315 par = boost::next(paragraphs.begin(), runparams.par_begin);
316 pend = boost::next(paragraphs.begin(), runparams.par_end);
317 // runparams will be passed to nested paragraphs, so
318 // we have to reset the range parameters.
319 const_cast<OutputParams&>(runparams).par_begin = 0;
320 const_cast<OutputParams&>(runparams).par_end = 0;
323 while (par != pend) {
324 LayoutPtr const & style = par->layout();
325 ParagraphList::const_iterator lastpar = par;
326 ParagraphList::const_iterator send;
328 switch (style->latextype) {
329 case LATEX_COMMAND: {
330 send = searchCommand(par, pend);
331 par = makeCommand(buf, os, runparams, paragraphs, par,send);
334 case LATEX_ENVIRONMENT:
335 case LATEX_ITEM_ENVIRONMENT: {
336 send = searchEnvironment(par, pend);
337 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
340 case LATEX_PARAGRAPH:
341 send = searchParagraph(par, pend);
342 par = makeParagraph(buf, os, runparams, paragraphs, par,send);
347 // makeEnvironment may process more than one paragraphs and bypass pend
348 if (std::distance(lastpar, par) >= std::distance(lastpar, pend))