lyx_mirror/src/output_xhtml.cpp

439 lines
11 KiB
C++
Raw Normal View History

/**
* \file output_xhtml.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Richard Heck
*
* This code is based upon output_docbook.cpp
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "output_xhtml.h"
#include "Buffer.h"
#include "buffer_funcs.h"
#include "BufferParams.h"
#include "Counters.h"
#include "Layout.h"
#include "OutputParams.h"
#include "Paragraph.h"
#include "paragraph_funcs.h"
#include "ParagraphList.h"
#include "ParagraphParameters.h"
#include "sgml.h"
#include "TextClass.h"
#include "support/lassert.h"
#include "support/debug.h"
#include "support/lstrings.h"
#include <boost/next_prior.hpp>
#include <vector>
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace html {
docstring escapeChar(char_type c)
{
docstring str;
switch (c) {
case ' ':
str += " ";
break;
case '&':
str += "&amp;";
break;
case '<':
str += "&lt;";
break;
case '>':
str += "&gt;";
break;
default:
str += c;
break;
}
return str;
}
// FIXME do something here.
docstring htmlize(docstring const & str) {
return str;
}
// FIXME This needs to be protected somehow.
static vector<string> taglist;
bool openTag(odocstream & os, string const & tag, string const & attr)
{
if (tag.empty())
return false;
// FIXME This is completely primitive. We need something
// a lot better.
// Now do some checks on nesting of tags.
if (tag == "p")
if (find(taglist.begin(), taglist.end(), "p") != taglist.end())
return false;
os << from_ascii("<" + tag + (attr.empty() ? "" : " " + attr) + ">");
taglist.push_back(tag);
return true;
}
bool closeTag(odocstream & os, string const & tag)
{
if (tag.empty())
return false;
// FIXME Check for proper nesting
if (taglist.empty()){
LYXERR0("Last tag not found when closing `" << tag << "'!");
return false;
}
string const & lasttag = taglist.back();
if (lasttag != tag) {
LYXERR0("Last tag was `" << lasttag << "' when closing `" << tag << "'!");
return false;
}
taglist.pop_back();
os << from_ascii("</" + tag + ">");
return true;
}
} // html
namespace {
bool openTag(odocstream & os, Layout const & lay)
{
return html::openTag(os, lay.htmltag(), lay.htmlattr());
}
bool closeTag(odocstream & os, Layout const & lay)
{
return html::closeTag(os, lay.htmltag());
}
bool openLabelTag(odocstream & os, Layout const & lay)
{
return html::openTag(os, lay.htmllabel(), lay.htmllabelattr());
}
bool closeLabelTag(odocstream & os, Layout const & lay)
{
return html::closeTag(os, lay.htmllabel());
}
bool openItemTag(odocstream & os, Layout const & lay)
{
return html::openTag(os, lay.htmlitem(), lay.htmlitemattr());
}
bool closeItemTag(odocstream & os, Layout const & lay)
{
return html::closeTag(os, lay.htmlitem());
}
ParagraphList::const_iterator searchParagraph(
ParagraphList::const_iterator p,
ParagraphList::const_iterator const & pend)
{
for (++p; p != pend && p->layout().latextype == LATEX_PARAGRAPH; ++p)
;
return p;
}
ParagraphList::const_iterator searchEnvironment(
ParagraphList::const_iterator p,
ParagraphList::const_iterator const & pend)
{
Layout const & bstyle = p->layout();
size_t const depth = p->params().depth();
for (++p; p != pend; ++p) {
Layout const & style = p->layout();
// It shouldn't happen that e.g. a section command occurs inside
// a quotation environment, at a higher depth, but as of 6/2009,
// it can happen. We pretend that it's just at lowest depth.
if (style.latextype == LATEX_COMMAND)
return p;
// If depth is down, we're done
if (p->params().depth() < depth)
return p;
// If depth is up, we're not done
if (p->params().depth() > depth)
continue;
// Now we know we are at the same depth
if (style.latextype == LATEX_PARAGRAPH
|| style.latexname() != bstyle.latexname())
return p;
}
return pend;
}
ParagraphList::const_iterator makeParagraphs(Buffer const & buf,
odocstream & os,
OutputParams const & runparams,
ParagraphList const & paragraphs,
ParagraphList::const_iterator const & pbegin,
ParagraphList::const_iterator const & pend)
{
ParagraphList::const_iterator par = pbegin;
for (; par != pend; ++par) {
Layout const & lay = par->layout();
if (!lay.counter.empty())
buf.params().documentClass().counters().step(lay.counter);
// FIXME We should see if there's a label to be output and
// do something with it.
if (par != pbegin)
os << '\n';
bool const opened = openTag(os, lay);
docstring const deferred = par->simpleLyXHTMLOnePar(buf, os, runparams,
outerFont(distance(paragraphs.begin(), par), paragraphs));
if (opened) {
closeTag(os, lay);
os << '\n';
}
if (!deferred.empty())
os << deferred << '\n';
}
return pend;
}
ParagraphList::const_iterator makeBibliography(Buffer const & buf,
odocstream & os,
OutputParams const & runparams,
ParagraphList const & paragraphs,
ParagraphList::const_iterator const & pbegin,
ParagraphList::const_iterator const & pend)
{
os << "<h2 class='bibliography'>"
<< pbegin->layout().labelstring()
<< "</h2>\n"
<< "<div class='bibliography'>\n";
makeParagraphs(buf, os, runparams, paragraphs, pbegin, pend);
os << "</div>";
return pend;
}
ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
odocstream & os,
OutputParams const & runparams,
ParagraphList const & paragraphs,
ParagraphList::const_iterator const & pbegin,
ParagraphList::const_iterator const & pend)
{
ParagraphList::const_iterator par = pbegin;
Layout const & bstyle = par->layout();
depth_type const origdepth = pbegin->params().depth();
// Open tag for this environment
bool const main_tag_opened = openTag(os, bstyle);
os << '\n';
// we will on occasion need to remember a layout from before.
Layout const * lastlay = 0;
while (par != pend) {
Layout const & style = par->layout();
if (!style.counter.empty())
buf.params().documentClass().counters().step(style.counter);
ParagraphList::const_iterator send;
// this will be positive, if we want to skip the initial word
// (if it's been taken for the label).
pos_type sep = 0;
switch (style.latextype) {
case LATEX_ENVIRONMENT:
case LATEX_LIST_ENVIRONMENT:
case LATEX_ITEM_ENVIRONMENT: {
// There are two possiblities in this case.
// One is that we are still in the environment in which we
// started---which we will be if the depth is the same.
if (par->params().depth() == origdepth) {
Layout const & cstyle = par->layout();
if (lastlay != 0) {
closeItemTag(os, *lastlay);
lastlay = 0;
}
bool const labelfirst = cstyle.htmllabelfirst();
bool item_tag_opened = false;
if (!labelfirst)
item_tag_opened = openItemTag(os, cstyle);
if (cstyle.labeltype == LABEL_MANUAL) {
bool const label_tag_opened = openLabelTag(os, cstyle);
sep = par->firstWordLyXHTML(os, runparams);
if (label_tag_opened)
closeLabelTag(os, cstyle);
os << '\n';
}
// FIXME Why did I put that first condition??
else if (style.latextype == LATEX_ENVIRONMENT
&& style.labeltype != LABEL_NO_LABEL) {
bool const label_tag_opened = openLabelTag(os, cstyle);
os << pbegin->expandLabel(style, buf.params(), false);
if (label_tag_opened)
closeLabelTag(os, cstyle);
os << '\n';
}
if (labelfirst)
item_tag_opened = openItemTag(os, cstyle);
else
os << "<span class='item'>";
par->simpleLyXHTMLOnePar(buf, os, runparams,
outerFont(distance(paragraphs.begin(), par), paragraphs), sep);
if (!labelfirst)
os << "</span>";
++par;
if (item_tag_opened) {
// We may not want to close the tag yet, in particular,
// if we're not at the end...
if (par != pend
// and are doing items...
&& style.latextype == LATEX_ITEM_ENVIRONMENT
// and if the depth has changed...
&& par->params().depth() != origdepth) {
// then we'll save this layout for later, and close it when
// we get another item.
lastlay = &cstyle;
} else {
closeItemTag(os, cstyle);
}
os << '\n';
}
}
// The other possibility is that the depth has increased, in which
// case we need to recurse.
else {
send = searchEnvironment(par, pend);
par = makeEnvironment(buf, os, runparams, paragraphs, par, send);
}
break;
}
case LATEX_PARAGRAPH:
send = searchParagraph(par, pend);
par = makeParagraphs(buf, os, runparams, paragraphs, par, send);
break;
// Shouldn't happen
case LATEX_BIB_ENVIRONMENT:
send = par;
++send;
par = makeParagraphs(buf, os, runparams, paragraphs, par, send);
break;
// Shouldn't happen
case LATEX_COMMAND:
++par;
break;
}
}
if (lastlay != 0)
closeItemTag(os, *lastlay);
if (main_tag_opened)
closeTag(os, bstyle);
os << '\n';
return pend;
}
void makeCommand(Buffer const & buf,
odocstream & os,
OutputParams const & runparams,
ParagraphList const & paragraphs,
ParagraphList::const_iterator const & pbegin)
{
Layout const & style = pbegin->layout();
if (!style.counter.empty())
buf.params().documentClass().counters().step(style.counter);
bool const main_tag_opened = openTag(os, style);
// Label around sectioning number:
// FIXME Probably need to account for LABEL_MANUAL
if (style.labeltype != LABEL_NO_LABEL) {
bool const label_tag_opened = openLabelTag(os, style);
os << pbegin->expandLabel(style, buf.params(), false);
if (label_tag_opened)
closeLabelTag(os, style);
// Otherwise the label might run together with the text
os << ' ';
}
pbegin->simpleLyXHTMLOnePar(buf, os, runparams,
outerFont(distance(paragraphs.begin(), pbegin), paragraphs));
if (main_tag_opened)
closeTag(os, style);
os << '\n';
}
} // end anonymous namespace
void xhtmlParagraphs(ParagraphList const & paragraphs,
Buffer const & buf,
odocstream & os,
OutputParams const & runparams)
{
ParagraphList::const_iterator par = paragraphs.begin();
ParagraphList::const_iterator pend = paragraphs.end();
while (par != pend) {
Layout const & style = par->layout();
ParagraphList::const_iterator lastpar = par;
ParagraphList::const_iterator send;
switch (style.latextype) {
case LATEX_COMMAND: {
// The files with which we are working never have more than
// one paragraph in a command structure.
makeCommand(buf, os, runparams, paragraphs, par);
++par;
break;
}
case LATEX_ENVIRONMENT:
case LATEX_LIST_ENVIRONMENT:
case LATEX_ITEM_ENVIRONMENT: {
send = searchEnvironment(par, pend);
par = makeEnvironment(buf, os, runparams, paragraphs, par, send);
break;
}
case LATEX_BIB_ENVIRONMENT: {
send = searchEnvironment(par, pend);
par = makeBibliography(buf, os, runparams, paragraphs, par, send);
break;
}
case LATEX_PARAGRAPH:
send = searchParagraph(par, pend);
par = makeParagraphs(buf, os, runparams, paragraphs, par, send);
break;
}
// FIXME??
// makeEnvironment may process more than one paragraphs and bypass pend
if (distance(lastpar, par) >= distance(lastpar, pend))
break;
}
}
} // namespace lyx