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 "paragraph_funcs.h"
25 #include "ParagraphList.h"
26 #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 This needs to be protected somehow.
69 static vector<string> taglist;
71 bool openTag(odocstream & os, string const & tag, string const & attr)
75 // FIXME This is completely primitive. We need something
77 // Now do some checks on nesting of tags.
79 if (find(taglist.begin(), taglist.end(), "p") != taglist.end())
81 os << from_ascii("<" + tag + (attr.empty() ? "" : " " + attr) + ">");
82 taglist.push_back(tag);
87 bool closeTag(odocstream & os, string const & tag)
91 // FIXME Check for proper nesting
93 LYXERR0("Last tag not found when closing `" << tag << "'!");
96 string const & lasttag = taglist.back();
98 LYXERR0("Last tag was `" << lasttag << "' when closing `" << tag << "'!");
102 os << from_ascii("</" + tag + ">");
112 bool openTag(odocstream & os, Layout const & lay)
114 return html::openTag(os, lay.htmltag(), lay.htmlattr());
118 bool closeTag(odocstream & os, Layout const & lay)
120 return html::closeTag(os, lay.htmltag());
124 bool openLabelTag(odocstream & os, Layout const & lay)
126 return html::openTag(os, lay.htmllabel(), lay.htmllabelattr());
130 bool closeLabelTag(odocstream & os, Layout const & lay)
132 return html::closeTag(os, lay.htmllabel());
136 bool openItemTag(odocstream & os, Layout const & lay)
138 return html::openTag(os, lay.htmlitem(), lay.htmlitemattr());
142 bool closeItemTag(odocstream & os, Layout const & lay)
144 return html::closeTag(os, lay.htmlitem());
147 ParagraphList::const_iterator searchParagraph(
148 ParagraphList::const_iterator p,
149 ParagraphList::const_iterator const & pend)
151 for (++p; p != pend && p->layout().latextype == LATEX_PARAGRAPH; ++p)
158 ParagraphList::const_iterator searchEnvironment(
159 ParagraphList::const_iterator p,
160 ParagraphList::const_iterator const & pend)
162 Layout const & bstyle = p->layout();
163 size_t const depth = p->params().depth();
164 for (++p; p != pend; ++p) {
165 Layout const & style = p->layout();
166 // It shouldn't happen that e.g. a section command occurs inside
167 // a quotation environment, at a higher depth, but as of 6/2009,
168 // it can happen. We pretend that it's just at lowest depth.
169 if (style.latextype == LATEX_COMMAND)
171 // If depth is down, we're done
172 if (p->params().depth() < depth)
174 // If depth is up, we're not done
175 if (p->params().depth() > depth)
177 // Now we know we are at the same depth
178 if (style.latextype == LATEX_PARAGRAPH
179 || style.latexname() != bstyle.latexname())
187 ParagraphList::const_iterator makeParagraphs(Buffer const & buf,
189 OutputParams const & runparams,
190 ParagraphList const & paragraphs,
191 ParagraphList::const_iterator const & pbegin,
192 ParagraphList::const_iterator const & pend)
194 ParagraphList::const_iterator par = pbegin;
195 for (; par != pend; ++par) {
196 Layout const & lay = par->layout();
199 bool const opened = openTag(os, lay);
200 par->simpleLyXHTMLOnePar(buf, os, runparams,
201 outerFont(distance(paragraphs.begin(), par), paragraphs));
211 ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
213 OutputParams const & runparams,
214 ParagraphList const & paragraphs,
215 ParagraphList::const_iterator const & pbegin,
216 ParagraphList::const_iterator const & pend) {
218 ParagraphList::const_iterator par = pbegin;
219 Layout const & bstyle = par->layout();
220 depth_type const origdepth = pbegin->params().depth();
222 // Open tag for this environment
223 bool const main_tag_opened = openTag(os, bstyle);
226 // we will on occasion need to remember a layout from before.
227 Layout const * lastlay = 0;
229 while (par != pend) {
230 Layout const & style = par->layout();
231 ParagraphList::const_iterator send;
232 // this will be positive, if we want to skip the initial word
233 // (if it's been taken for the label).
236 switch (style.latextype) {
237 case LATEX_ENVIRONMENT:
238 case LATEX_LIST_ENVIRONMENT:
239 case LATEX_ITEM_ENVIRONMENT: {
240 // There are two possiblities in this case.
241 // One is that we are still in the environment in which we
242 // started---which we will be if the depth is the same.
243 if (par->params().depth() == origdepth) {
245 closeItemTag(os, *lastlay);
248 Layout const & cstyle = par->layout();
249 if (cstyle.labeltype == LABEL_MANUAL) {
250 bool const label_tag_opened = openLabelTag(os, cstyle);
251 sep = par->firstWordLyXHTML(os, runparams);
252 if (label_tag_opened)
253 closeLabelTag(os, cstyle);
255 } else if (style.latextype == LATEX_ENVIRONMENT
256 && style.labeltype != LABEL_NO_LABEL) {
257 bool const label_tag_opened = openLabelTag(os, cstyle);
258 if (!style.counter.empty())
259 buf.params().documentClass().counters().step(cstyle.counter);
260 os << pbegin->expandLabel(style, buf.params(), false);
261 if (label_tag_opened)
262 closeLabelTag(os, cstyle);
266 bool const item_tag_opened = openItemTag(os, cstyle);
267 par->simpleLyXHTMLOnePar(buf, os, runparams,
268 outerFont(distance(paragraphs.begin(), par), paragraphs), sep);
270 // We may not want to close the tag yet, in particular,
272 // if we're not at the end...
274 // and are doing items...
275 && style.latextype == LATEX_ITEM_ENVIRONMENT
276 // and if the depth has changed...
277 && par->params().depth() != origdepth) {
278 // then we'll save this layout for later, and close it when
279 // we get another item.
282 closeItemTag(os, cstyle); // FIXME
286 // The other possibility is that the depth has increased, in which
287 // case we need to recurse.
289 send = searchEnvironment(par, pend);
290 par = makeEnvironment(buf, os, runparams, paragraphs, par, send);
294 case LATEX_PARAGRAPH:
295 send = searchParagraph(par, pend);
296 par = makeParagraphs(buf, os, runparams, paragraphs, par, send);
299 case LATEX_BIB_ENVIRONMENT:
306 closeItemTag(os, *lastlay);
308 closeTag(os, bstyle);
314 void makeCommand(Buffer const & buf,
316 OutputParams const & runparams,
317 ParagraphList const & paragraphs,
318 ParagraphList::const_iterator const & pbegin)
320 Layout const & style = pbegin->layout();
322 bool const main_tag_opened = openTag(os, style);
324 // Label around sectioning number:
325 if (style.labeltype != LABEL_NO_LABEL) {
326 bool const label_tag_opened = openLabelTag(os, style);
327 if (!style.counter.empty())
328 buf.params().documentClass().counters().step(style.counter);
329 os << pbegin->expandLabel(style, buf.params(), false);
330 if (label_tag_opened)
331 closeLabelTag(os, style);
332 // Otherwise the label might run together with the text
336 pbegin->simpleLyXHTMLOnePar(buf, os, runparams,
337 outerFont(distance(paragraphs.begin(), pbegin), paragraphs));
343 } // end anonymous namespace
346 void xhtmlParagraphs(ParagraphList const & paragraphs,
349 OutputParams const & runparams)
351 ParagraphList::const_iterator par = paragraphs.begin();
352 ParagraphList::const_iterator pend = paragraphs.end();
354 while (par != pend) {
356 Layout const & style = par->layout();
357 ParagraphList::const_iterator lastpar = par;
358 ParagraphList::const_iterator send;
360 switch (style.latextype) {
361 case LATEX_COMMAND: {
362 // The files with which we are working never have more than
363 // one paragraph in a command structure.
364 makeCommand(buf, os, runparams, paragraphs, par);
368 case LATEX_ENVIRONMENT:
369 case LATEX_LIST_ENVIRONMENT:
370 case LATEX_ITEM_ENVIRONMENT: {
371 send = searchEnvironment(par, pend);
372 par = makeEnvironment(buf, os, runparams, paragraphs, par,send);
375 case LATEX_PARAGRAPH:
376 send = searchParagraph(par, pend);
377 par = makeParagraphs(buf, os, runparams, paragraphs, par,send);
379 case LATEX_BIB_ENVIRONMENT:
385 // makeEnvironment may process more than one paragraphs and bypass pend
386 if (distance(lastpar, par) >= distance(lastpar, pend))