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 p,
165 ParagraphList::const_iterator const & pend)
167 Layout const & bstyle = p->layout();
168 size_t const depth = p->params().depth();
169 for (++p; p != pend; ++p) {
170 Layout const & style = p->layout();
171 // It shouldn't happen that e.g. a section command occurs inside
172 // a quotation environment, at a higher depth, but as of 6/2009,
173 // it can happen. We pretend that it's just at lowest depth.
174 if (style.latextype == LATEX_COMMAND)
176 // If depth is down, we're done
177 if (p->params().depth() < depth)
179 // If depth is up, we're not done
180 if (p->params().depth() > depth)
182 // Now we know we are at the same depth
183 if (style.latextype == LATEX_PARAGRAPH
184 || 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);
240 ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf,
242 OutputParams const & runparams,
244 ParagraphList::const_iterator const & pbegin,
245 ParagraphList::const_iterator const & pend)
247 ParagraphList::const_iterator const begin = text.paragraphs().begin();
248 ParagraphList::const_iterator par = pbegin;
249 Layout const & bstyle = par->layout();
250 depth_type const origdepth = pbegin->params().depth();
252 // Open tag for this environment
253 bool const main_tag_opened = openTag(os, bstyle);
256 // we will on occasion need to remember a layout from before.
257 Layout const * lastlay = 0;
259 while (par != pend) {
260 Layout const & style = par->layout();
261 if (!style.counter.empty())
262 buf.params().documentClass().counters().step(style.counter);
263 ParagraphList::const_iterator send;
264 // this will be positive, if we want to skip the initial word
265 // (if it's been taken for the label).
268 switch (style.latextype) {
269 case LATEX_ENVIRONMENT:
270 case LATEX_LIST_ENVIRONMENT:
271 case LATEX_ITEM_ENVIRONMENT: {
272 // There are two possiblities in this case.
273 // One is that we are still in the environment in which we
274 // started---which we will be if the depth is the same.
275 if (par->params().depth() == origdepth) {
276 Layout const & cstyle = par->layout();
278 closeItemTag(os, *lastlay);
281 bool const labelfirst = cstyle.htmllabelfirst();
282 bool item_tag_opened = false;
284 item_tag_opened = openItemTag(os, cstyle);
285 if (cstyle.labeltype == LABEL_MANUAL) {
286 bool const label_tag_opened = openLabelTag(os, cstyle);
287 sep = par->firstWordLyXHTML(os, runparams);
288 if (label_tag_opened)
289 closeLabelTag(os, cstyle);
292 // FIXME Why did I put that first condition??
293 else if (style.latextype == LATEX_ENVIRONMENT
294 && style.labeltype != LABEL_NO_LABEL) {
295 bool const label_tag_opened = openLabelTag(os, cstyle);
296 os << pbegin->expandLabel(style, buf.params(), false);
297 if (label_tag_opened)
298 closeLabelTag(os, cstyle);
302 item_tag_opened = openItemTag(os, cstyle);
304 os << "<span class='item'>";
305 par->simpleLyXHTMLOnePar(buf, os, runparams,
306 text.outerFont(distance(begin, par)), sep);
310 if (item_tag_opened) {
311 // We may not want to close the tag yet, in particular,
312 // if we're not at the end...
314 // and are doing items...
315 && style.latextype == LATEX_ITEM_ENVIRONMENT
316 // and if the depth has changed...
317 && par->params().depth() != origdepth) {
318 // then we'll save this layout for later, and close it when
319 // we get another item.
322 closeItemTag(os, cstyle);
327 // The other possibility is that the depth has increased, in which
328 // case we need to recurse.
330 send = searchEnvironmentHtml(par, pend);
331 par = makeEnvironmentHtml(buf, os, runparams, text, par, send);
335 case LATEX_PARAGRAPH:
336 send = searchParagraphHtml(par, pend);
337 par = makeParagraphs(buf, os, runparams, text, par, send);
340 case LATEX_BIB_ENVIRONMENT:
343 par = makeParagraphs(buf, os, runparams, text, par, send);
353 closeItemTag(os, *lastlay);
355 closeTag(os, bstyle);
361 void makeCommand(Buffer const & buf,
363 OutputParams const & runparams,
365 ParagraphList::const_iterator const & pbegin)
367 Layout const & style = pbegin->layout();
368 if (!style.counter.empty())
369 buf.params().documentClass().counters().step(style.counter);
371 bool const main_tag_opened = openTag(os, style);
373 // Label around sectioning number:
374 // FIXME Probably need to account for LABEL_MANUAL
375 if (style.labeltype != LABEL_NO_LABEL) {
376 bool const label_tag_opened = openLabelTag(os, style);
377 os << pbegin->expandLabel(style, buf.params(), false);
378 if (label_tag_opened)
379 closeLabelTag(os, style);
380 // Otherwise the label might run together with the text
384 ParagraphList::const_iterator const begin = text.paragraphs().begin();
385 pbegin->simpleLyXHTMLOnePar(buf, os, runparams,
386 text.outerFont(distance(begin, pbegin)));
392 } // end anonymous namespace
395 void xhtmlParagraphs(Text const & text,
398 OutputParams const & runparams)
400 ParagraphList const & paragraphs = text.paragraphs();
401 ParagraphList::const_iterator par = paragraphs.begin();
402 ParagraphList::const_iterator pend = paragraphs.end();
404 while (par != pend) {
405 Layout const & style = par->layout();
406 ParagraphList::const_iterator lastpar = par;
407 ParagraphList::const_iterator send;
409 switch (style.latextype) {
410 case LATEX_COMMAND: {
411 // The files with which we are working never have more than
412 // one paragraph in a command structure.
413 makeCommand(buf, os, runparams, text, par);
417 case LATEX_ENVIRONMENT:
418 case LATEX_LIST_ENVIRONMENT:
419 case LATEX_ITEM_ENVIRONMENT: {
420 send = searchEnvironmentHtml(par, pend);
421 par = makeEnvironmentHtml(buf, os, runparams, text, par, send);
424 case LATEX_BIB_ENVIRONMENT: {
425 send = searchEnvironmentHtml(par, pend);
426 par = makeBibliography(buf, os, runparams, text, par, send);
429 case LATEX_PARAGRAPH:
430 send = searchParagraphHtml(par, pend);
431 par = makeParagraphs(buf, os, runparams, text, par, send);
435 // makeEnvironment may process more than one paragraphs and bypass pend
436 if (distance(lastpar, par) >= distance(lastpar, pend))