2 * \file output_xhtml.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * This code is based upon output_docbook.cpp
10 * Full author contact details are available in file CREDITS.
15 #include "output_xhtml.h"
18 #include "buffer_funcs.h"
19 #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>
38 using namespace lyx::support;
44 docstring escapeChar(char_type c)
68 // FIXME do something here.
69 docstring htmlize(docstring const & str) {
73 // FIXME This needs to be protected somehow.
74 static vector<string> taglist;
76 bool openTag(odocstream & os, string const & tag, string const & attr)
80 // FIXME This is completely primitive. We need something
82 // Now do some checks on nesting of tags.
84 if (find(taglist.begin(), taglist.end(), "p") != taglist.end())
86 os << from_ascii("<" + tag + (attr.empty() ? "" : " " + attr) + ">");
87 taglist.push_back(tag);
92 bool closeTag(odocstream & os, string const & tag)
96 // FIXME Check for proper nesting
98 LYXERR0("Last tag not found when closing `" << tag << "'!");
101 string const & lasttag = taglist.back();
102 if (lasttag != tag) {
103 LYXERR0("Last tag was `" << lasttag << "' when closing `" << tag << "'!");
107 os << from_ascii("</" + tag + ">");
117 bool openTag(odocstream & os, Layout const & lay)
119 return html::openTag(os, lay.htmltag(), lay.htmlattr());
123 bool closeTag(odocstream & os, Layout const & lay)
125 return html::closeTag(os, lay.htmltag());
129 bool openLabelTag(odocstream & os, Layout const & lay)
131 return html::openTag(os, lay.htmllabel(), lay.htmllabelattr());
135 bool closeLabelTag(odocstream & os, Layout const & lay)
137 return html::closeTag(os, lay.htmllabel());
141 bool openItemTag(odocstream & os, Layout const & lay)
143 return html::openTag(os, lay.htmlitem(), lay.htmlitemattr());
147 bool closeItemTag(odocstream & os, Layout const & lay)
149 return html::closeTag(os, lay.htmlitem());
152 ParagraphList::const_iterator searchParagraphHtml(
153 ParagraphList::const_iterator p,
154 ParagraphList::const_iterator const & pend)
156 for (++p; p != pend && p->layout().latextype == LATEX_PARAGRAPH; ++p)
163 ParagraphList::const_iterator searchEnvironmentHtml(
164 ParagraphList::const_iterator const pstart,
165 ParagraphList::const_iterator const & pend)
167 ParagraphList::const_iterator p = pstart;
168 Layout const & bstyle = p->layout();
169 size_t const depth = p->params().depth();
170 for (++p; p != pend; ++p) {
171 Layout const & style = p->layout();
172 // It shouldn't happen that e.g. a section command occurs inside
173 // a quotation environment, at a higher depth, but as of 6/2009,
174 // it can happen. We pretend that it's just at lowest depth.
175 if (style.latextype == LATEX_COMMAND)
177 // If depth is down, we're done
178 if (p->params().depth() < depth)
180 // If depth is up, we're not done
181 if (p->params().depth() > depth)
183 // Now we know we are at the same depth
184 if (style.latextype == LATEX_PARAGRAPH
185 || style.latexname() != bstyle.latexname())
192 ParagraphList::const_iterator makeParagraphs(Buffer const & buf,
194 OutputParams const & runparams,
196 ParagraphList::const_iterator const & pbegin,
197 ParagraphList::const_iterator const & pend)
199 ParagraphList::const_iterator const begin = text.paragraphs().begin();
200 ParagraphList::const_iterator par = pbegin;
201 for (; par != pend; ++par) {
202 Layout const & lay = par->layout();
203 if (!lay.counter.empty())
204 buf.params().documentClass().counters().step(lay.counter);
205 // FIXME We should see if there's a label to be output and
206 // do something with it.
209 bool const opened = openTag(os, lay);
210 docstring const deferred = par->simpleLyXHTMLOnePar(buf, os, runparams,
211 text.outerFont(distance(begin, par)));
216 if (!deferred.empty())
217 os << deferred << '\n';
223 ParagraphList::const_iterator makeBibliography(Buffer const & buf,
225 OutputParams const & runparams,
227 ParagraphList::const_iterator const & pbegin,
228 ParagraphList::const_iterator const & pend)
230 os << "<h2 class='bibliography'>"
231 << pbegin->layout().labelstring(false)
233 << "<div class='bibliography'>\n";
234 makeParagraphs(buf, os, runparams, text, pbegin, pend);
241 bool isNormalEnv(Layout const & lay)
243 return lay.latextype == LATEX_ENVIRONMENT;
247 ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf,
249 OutputParams const & runparams,
251 ParagraphList::const_iterator const & pbegin,
252 ParagraphList::const_iterator const & pend)
254 ParagraphList::const_iterator const begin = text.paragraphs().begin();
255 ParagraphList::const_iterator par = pbegin;
256 Layout const & bstyle = par->layout();
257 depth_type const origdepth = pbegin->params().depth();
259 // Open tag for this environment
260 bool const main_tag_opened = openTag(os, bstyle);
263 // we will on occasion need to remember a layout from before.
264 Layout const * lastlay = 0;
266 while (par != pend) {
267 Layout const & style = par->layout();
268 // the counter only gets stepped if we're in some kind of list,
269 // or if it's the first time through.
270 if (!style.counter.empty() && (par == pbegin || !isNormalEnv(style)))
271 buf.params().documentClass().counters().step(style.counter);
272 ParagraphList::const_iterator send;
273 // this will be positive, if we want to skip the initial word
274 // (if it's been taken for the label).
277 switch (style.latextype) {
278 case LATEX_ENVIRONMENT:
279 case LATEX_LIST_ENVIRONMENT:
280 case LATEX_ITEM_ENVIRONMENT: {
281 // There are two possiblities in this case.
282 // One is that we are still in the environment in which we
283 // started---which we will be if the depth is the same.
284 if (par->params().depth() == origdepth) {
285 LASSERT(bstyle == style, /* */);
287 closeItemTag(os, *lastlay);
290 bool item_tag_opened = false;
291 bool const labelfirst = style.htmllabelfirst();
292 bool madelabel = false;
293 if (isNormalEnv(style)) {
294 // in this case, we print the label only for the first
295 // paragraph (as in a theorem).
296 item_tag_opened = openItemTag(os, style);
297 if (par == pbegin && style.htmllabel() != "NONE") {
298 docstring const lbl =
299 pbegin->expandLabel(style, buf.params(), false);
301 bool const label_tag_opened = openLabelTag(os, style);
303 if (label_tag_opened)
304 closeLabelTag(os, style);
308 } else { // some kind of list
310 item_tag_opened = openItemTag(os, style);
311 if (style.labeltype == LABEL_MANUAL
312 && style.htmllabel() != "NONE") {
313 madelabel = openLabelTag(os, style);
314 sep = par->firstWordLyXHTML(os, runparams);
316 closeLabelTag(os, style);
319 else if (style.labeltype != LABEL_NO_LABEL
320 && style.htmllabel() != "NONE") {
321 madelabel = openLabelTag(os, style);
322 os << par->expandLabel(style, buf.params(), false);
324 closeLabelTag(os, style);
328 item_tag_opened = openItemTag(os, style);
330 os << "<span class='" << style.name() << "inneritem'>";
332 par->simpleLyXHTMLOnePar(buf, os, runparams,
333 text.outerFont(distance(begin, par)), sep);
334 if (!isNormalEnv(style) && !labelfirst && madelabel)
337 if (item_tag_opened) {
338 // We may not want to close the tag yet, in particular,
339 // if we're not at the end...
341 // and are doing items...
342 && style.latextype == LATEX_ITEM_ENVIRONMENT
343 // and if the depth has changed...
344 && par->params().depth() != origdepth) {
345 // then we'll save this layout for later, and close it when
346 // we get another item.
349 closeItemTag(os, style);
353 // The other possibility is that the depth has increased, in which
354 // case we need to recurse.
356 send = searchEnvironmentHtml(par, pend);
357 par = makeEnvironmentHtml(buf, os, runparams, text, par, send);
361 case LATEX_PARAGRAPH:
362 send = searchParagraphHtml(par, pend);
363 par = makeParagraphs(buf, os, runparams, text, par, send);
366 case LATEX_BIB_ENVIRONMENT:
369 par = makeParagraphs(buf, os, runparams, text, par, send);
379 closeItemTag(os, *lastlay);
381 closeTag(os, bstyle);
387 void makeCommand(Buffer const & buf,
389 OutputParams const & runparams,
391 ParagraphList::const_iterator const & pbegin)
393 Layout const & style = pbegin->layout();
394 if (!style.counter.empty())
395 buf.params().documentClass().counters().step(style.counter);
397 bool const main_tag_opened = openTag(os, style);
399 // Label around sectioning number:
400 // FIXME Probably need to account for LABEL_MANUAL
401 if (style.labeltype != LABEL_NO_LABEL) {
402 bool const label_tag_opened = openLabelTag(os, style);
403 os << pbegin->expandLabel(style, buf.params(), false);
404 if (label_tag_opened)
405 closeLabelTag(os, style);
406 // Otherwise the label might run together with the text
410 ParagraphList::const_iterator const begin = text.paragraphs().begin();
411 pbegin->simpleLyXHTMLOnePar(buf, os, runparams,
412 text.outerFont(distance(begin, pbegin)));
418 } // end anonymous namespace
421 void xhtmlParagraphs(Text const & text,
424 OutputParams const & runparams)
426 ParagraphList const & paragraphs = text.paragraphs();
427 ParagraphList::const_iterator par = paragraphs.begin();
428 ParagraphList::const_iterator pend = paragraphs.end();
430 while (par != pend) {
431 Layout const & style = par->layout();
432 ParagraphList::const_iterator lastpar = par;
433 ParagraphList::const_iterator send;
435 switch (style.latextype) {
436 case LATEX_COMMAND: {
437 // The files with which we are working never have more than
438 // one paragraph in a command structure.
439 makeCommand(buf, os, runparams, text, par);
443 case LATEX_ENVIRONMENT:
444 case LATEX_LIST_ENVIRONMENT:
445 case LATEX_ITEM_ENVIRONMENT: {
446 send = searchEnvironmentHtml(par, pend);
447 par = makeEnvironmentHtml(buf, os, runparams, text, par, send);
450 case LATEX_BIB_ENVIRONMENT: {
451 send = searchEnvironmentHtml(par, pend);
452 par = makeBibliography(buf, os, runparams, text, par, send);
455 case LATEX_PARAGRAPH:
456 send = searchParagraphHtml(par, pend);
457 par = makeParagraphs(buf, os, runparams, text, par, send);
461 // makeEnvironment may process more than one paragraphs and bypass pend
462 if (distance(lastpar, par) >= distance(lastpar, pend))