* 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.
}
-string escapeChar(char c, XHTMLStream::EscapeSettings e)
+docstring escapeChar(char c, XHTMLStream::EscapeSettings e)
{
- string str;
- switch (e) {
- case XHTMLStream::ESCAPE_NONE:
- str += c;
- break;
- case XHTMLStream::ESCAPE_ALL:
- if (c == '<') {
- str += "<";
- break;
- } else if (c == '>') {
- str += ">";
- break;
- }
- // fall through
- case XHTMLStream::ESCAPE_AND:
- if (c == '&')
- str += "&";
- else
- str +=c ;
- break;
- }
- return str;
-}
-
-
-// escape what needs escaping
-string htmlize(string const & str, XHTMLStream::EscapeSettings e)
-{
- ostringstream d;
- string::const_iterator it = str.begin();
- string::const_iterator en = str.end();
- for (; it != en; ++it)
- d << escapeChar(*it, e);
- return d.str();
-}
-
-
-string cleanAttr(string const & str)
-{
- string newname;
- string::const_iterator it = str.begin();
- string::const_iterator en = str.end();
- for (; it != en; ++it)
- newname += isAlnumASCII(*it) ? *it : '_';
- return newname;
+ LATTEST(static_cast<unsigned char>(c) < 0x80);
+ return escapeChar(static_cast<char_type>(c), e);
}
char_type const c = *it;
newname += isAlnumASCII(c) ? c : char_type('_');
}
- return newname;
+ return newname;
}
docstring StartTag::writeTag() const
{
- string output = "<" + tag_;
+ docstring output = '<' + from_utf8(tag_);
if (!attr_.empty())
- output += " " + html::htmlize(attr_, XHTMLStream::ESCAPE_NONE);
+ output += ' ' + html::htmlize(from_utf8(attr_), XHTMLStream::ESCAPE_NONE);
output += ">";
- return from_utf8(output);
+ return output;
}
}
-docstring ParTag::writeTag() const
+ParTag::ParTag(std::string const & tag, std::string attr,
+ std::string const & parid)
+ : StartTag(tag)
{
- docstring output = StartTag::writeTag();
-
- if (parid_.empty())
- return output;
-
- string const pattr = "id='" + parid_ + "'";
- output += html::CompTag("a", pattr).writeTag();
- return output;
+ if (!parid.empty())
+ attr += " id='" + parid + "'";
+ attr_ = attr;
}
docstring CompTag::writeTag() const
{
- string output = "<" + tag_;
+ docstring output = '<' + from_utf8(tag_);
if (!attr_.empty())
- output += " " + html::htmlize(attr_, XHTMLStream::ESCAPE_NONE);
+ output += ' ' + html::htmlize(from_utf8(attr_), XHTMLStream::ESCAPE_NONE);
output += " />";
- return from_utf8(output);
+ return output;
}
namespace {
string fontToTag(html::FontTypes type)
- {
+{
switch(type) {
case FT_EMPH:
return "em";
case FT_DBAR:
return "u";
case FT_SOUT:
+ case FT_XOUT:
return "del";
case FT_ITALIC:
return "i";
case FT_ROMAN:
case FT_SANS:
case FT_TYPE:
+ case FT_SIZE_TINY:
+ case FT_SIZE_SCRIPT:
+ case FT_SIZE_FOOTNOTE:
+ case FT_SIZE_SMALL:
+ case FT_SIZE_NORMAL:
+ case FT_SIZE_LARGE:
+ case FT_SIZE_LARGER:
+ case FT_SIZE_LARGEST:
+ case FT_SIZE_HUGE:
+ case FT_SIZE_HUGER:
+ case FT_SIZE_INCREASE:
+ case FT_SIZE_DECREASE:
return "span";
}
// kill warning
return "";
}
-StartTag fontToStartTag(html::FontTypes type)
- {
- string tag = fontToTag(type);
+string fontToAttribute(html::FontTypes type)
+{
switch(type) {
case FT_EMPH:
- return html::StartTag(tag);
case FT_BOLD:
- return html::StartTag(tag);
+ return "";
case FT_NOUN:
- return html::StartTag(tag, "class='lyxnoun'");
+ return "class='lyxnoun'";
case FT_UBAR:
- return html::StartTag(tag);
+ return "";
case FT_DBAR:
- return html::StartTag(tag, "class='dline'");
+ return "class='dline'";
+ case FT_XOUT:
case FT_SOUT:
- return html::StartTag(tag, "class='strikeout'");
+ return "class='strikeout'";
case FT_WAVE:
- return html::StartTag(tag, "class='wline'");
+ return "class='wline'";
case FT_ITALIC:
- return html::StartTag(tag);
+ return "";
case FT_UPRIGHT:
- return html::StartTag(tag, "style='font-style:normal;'");
+ return "style='font-style:normal;'";
case FT_SLANTED:
- return html::StartTag(tag, "style='font-style:oblique;'");
+ return "style='font-style:oblique;'";
case FT_SMALLCAPS:
- return html::StartTag(tag, "style='font-variant:small-caps;'");
+ return "style='font-variant:small-caps;'";
case FT_ROMAN:
- return html::StartTag(tag, "style='font-family:serif;'");
+ return "style='font-family:serif;'";
case FT_SANS:
- return html::StartTag(tag, "style='font-family:sans-serif;'");
+ return "style='font-family:sans-serif;'";
case FT_TYPE:
- return html::StartTag(tag, "style='font-family:monospace;'");
+ return "style='font-family:monospace;'";
+ case FT_SIZE_TINY:
+ case FT_SIZE_SCRIPT:
+ case FT_SIZE_FOOTNOTE:
+ return "style='font-size:x-small;'";
+ case FT_SIZE_SMALL:
+ return "style='font-size:small;'";
+ case FT_SIZE_NORMAL:
+ return "style='font-size:normal;'";
+ case FT_SIZE_LARGE:
+ return "style='font-size:large;'";
+ case FT_SIZE_LARGER:
+ case FT_SIZE_LARGEST:
+ return "style='font-size:x-large;'";
+ case FT_SIZE_HUGE:
+ case FT_SIZE_HUGER:
+ return "style='font-size:xx-large;'";
+ case FT_SIZE_INCREASE:
+ return "style='font-size:larger;'";
+ case FT_SIZE_DECREASE:
+ return "style='font-size:smaller;'";
}
// kill warning
- return StartTag("");
+ return "";
}
} // end anonymous namespace
FontTag::FontTag(FontTypes type)
- : StartTag(fontToStartTag(type)), font_type_(type)
+ : StartTag(fontToTag(type), fontToAttribute(type)), font_type_(type)
{}
#ifdef XHTML_DEBUG
-void XHTMLStream::dumpTagStack(string const & msg) const
+void XHTMLStream::dumpTagStack(string const & msg)
{
- writeError(msg + ": Tag Stack");
- TagStack::const_reverse_iterator it = tag_stack_.rbegin();
- TagStack::const_reverse_iterator en = tag_stack_.rend();
+ *this << html::CR();
+ writeError(msg);
+ *this << html::CR();
+ writeError("Tag Stack");
+ TagDeque::const_reverse_iterator it = tag_stack_.rbegin();
+ TagDeque::const_reverse_iterator en = tag_stack_.rend();
for (; it != en; ++it) {
- writeError(it->tag_);
+ writeError(it->get()->tag_);
}
+ writeError("End Tag Stack");
+ *this << html::CR();
writeError("Pending Tags");
it = pending_tags_.rbegin();
en = pending_tags_.rend();
for (; it != en; ++it) {
- writeError(it->tag_);
+ writeError(it->get()->tag_);
}
- writeError("End Tag Stack");
+ writeError("End Pending Tags");
+ *this << html::CR();
}
#endif
// we haven't had any content
return true;
+#ifdef XHTML_DEBUG
+ dumpTagStack("Beging Close Font Tags");
+#endif
+
// this may be a useless check, since we ought at least to have
// the parsep_tag. but it can't hurt too much to be careful.
if (tag_stack_.empty())
tag_stack_.pop_back();
// this shouldn't happen, since then the font tags
// weren't in any other tag.
- LBUFERR(!tag_stack_.empty());
+ LASSERT(!tag_stack_.empty(), return true);
curtag = tag_stack_.back();
}
+
+#ifdef XHTML_DEBUG
+ dumpTagStack("End Close Font Tags");
+#endif
if (*curtag == parsep_tag)
return true;
}
-void XHTMLStream::startParagraph(bool keep_empty)
+void XHTMLStream::startDivision(bool keep_empty)
{
pending_tags_.push_back(makeTagPtr(html::StartTag(parsep_tag)));
if (keep_empty)
clearTagDeque();
+#ifdef XHTML_DEBUG
+ dumpTagStack("StartDivision");
+#endif
}
-void XHTMLStream::endParagraph()
+void XHTMLStream::endDivision()
{
if (isTagPending(parsep_tag)) {
// this case is normal. it just means we didn't have content,
if (*cur_tag == parsep_tag)
break;
}
+
+#ifdef XHTML_DEBUG
+ dumpTagStack("EndDivision");
+#endif
+
return;
}
if (!isTagOpen(parsep_tag)) {
- writeError("No paragraph separation tag found in endParagraph().");
+ writeError("No division separation tag found in endDivision().");
return;
}
- // this case is also normal, if the parsep tag is the last one
+ // this case is also normal, if the parsep tag is the last one
// on the stack. otherwise, it's an error.
while (!tag_stack_.empty()) {
TagPtr const cur_tag = tag_stack_.back();
writeError("Tag `" + cur_tag->tag_ + "' still open at end of paragraph. Closing.");
os_ << cur_tag->writeEndTag();
}
+
+#ifdef XHTML_DEBUG
+ dumpTagStack("EndDivision");
+#endif
}
XHTMLStream & XHTMLStream::operator<<(char c)
{
clearTagDeque();
- string const d = html::escapeChar(c, escape_);
+ os_ << html::escapeChar(c, escape_);
escape_ = ESCAPE_ALL;
return *this;
}
XHTMLStream & XHTMLStream::operator<<(EscapeSettings e)
-{
+{
escape_ = e;
return *this;
}
-XHTMLStream & XHTMLStream::operator<<(html::StartTag const & tag)
+XHTMLStream & XHTMLStream::operator<<(html::StartTag const & tag)
{
if (tag.tag_.empty())
return *this;
}
-XHTMLStream & XHTMLStream::operator<<(html::CompTag const & tag)
+XHTMLStream & XHTMLStream::operator<<(html::CompTag const & tag)
{
if (tag.tag_.empty())
return *this;
// this is complicated, because we want to make sure that
-// everything is properly nested. the code ought to make
+// everything is properly nested. the code ought to make
// sure of that, but we won't assert (yet) if we run into
// a problem. we'll just output error messages and try our
// best to make things work.
if (!pending_tags_.empty()) {
if (etag == *pending_tags_.back()) {
- // we have <tag></tag>, so we discard it and remove it
+ // we have <tag></tag>, so we discard it and remove it
// from the pending_tags_.
pending_tags_.pop_back();
return *this;
}
// there is a pending tag that isn't the one we are trying
- // to close.
+ // to close.
// is this tag itself pending?
// non-const iterators because we may call erase().
for (; dit != den; ++dit) {
if (etag == **dit) {
// it was pending, so we just erase it
- writeError("Tried to close pending tag `" + etag.tag_
+ writeError("Tried to close pending tag `" + etag.tag_
+ "' when other tags were pending. Last pending tag is `"
- + pending_tags_.back()->tag_ + "'. Tag discarded.");
+ + to_utf8(pending_tags_.back()->writeTag())
+ + "'. Tag discarded.");
pending_tags_.erase(dit);
return *this;
}
}
// so etag isn't itself pending. is it even open?
if (!isTagOpen(etag)) {
- writeError("Tried to close `" + etag.tag_
+ writeError("Tried to close `" + etag.tag_
+ "' when tag was not open. Tag discarded.");
return *this;
}
// ok, so etag is open.
- // our strategy will be as below: we will do what we need to
+ // our strategy will be as below: we will do what we need to
// do to close this tag.
- string estr = "Closing tag `" + etag.tag_
+ string estr = "Closing tag `" + etag.tag_
+ "' when other tags are pending. Discarded pending tags:\n";
for (dit = pending_tags_.begin(); dit != den; ++dit)
- estr += (*dit)->tag_ + "\n";
+ estr += to_utf8(html::htmlize((*dit)->writeTag(), XHTMLStream::ESCAPE_ALL)) + "\n";
writeError(estr);
// clear the pending tags...
pending_tags_.clear();
if (tag_stack_.empty()) {
writeError("Tried to close `" + etag.tag_
+ "' when no tags were open!");
- return *this;
+ return *this;
}
// is the tag we are closing the last one we opened?
// ...and forget about it
tag_stack_.pop_back();
return *this;
- }
-
- // we are trying to close a tag other than the one last opened.
+ }
+
+ // we are trying to close a tag other than the one last opened.
// let's first see if this particular tag is still open somehow.
if (!isTagOpen(etag)) {
- writeError("Tried to close `" + etag.tag_
+ writeError("Tried to close `" + etag.tag_
+ "' when tag was not open. Tag discarded.");
return *this;
}
-
+
// so the tag was opened, but other tags have been opened since
// and not yet closed.
// if it's a font tag, though...
break;
if (!(*rit)->asFontTag()) {
// we'll just leave it and, presumably, have to close it later.
- writeError("Unable to close font tag `" + etag.tag_
+ writeError("Unable to close font tag `" + etag.tag_
+ "' due to open non-font tag `" + (*rit)->tag_ + "'.");
return *this;
}
}
-
+
// so we have e.g.:
// <em>this is <strong>bold
// and are being asked to closed em. we want:
tag_stack_.pop_back();
curtag = tag_stack_.back();
}
- os_ << etag.writeEndTag();
+ os_ << etag.writeEndTag();
tag_stack_.pop_back();
// ...and restore the other tags.
pending_tags_.push_back(*rit);
return *this;
}
-
+
// it wasn't a font tag.
- // so other tags were opened before this one and not properly closed.
- // so we'll close them, too. that may cause other issues later, but it
+ // so other tags were opened before this one and not properly closed.
+ // so we'll close them, too. that may cause other issues later, but it
// at least guarantees proper nesting.
- writeError("Closing tag `" + etag.tag_
+ writeError("Closing tag `" + etag.tag_
+ "' when other tags are open, namely:");
TagPtr curtag = tag_stack_.back();
while (etag != *curtag) {
// curtag is now the one we actually want.
os_ << curtag->writeEndTag();
tag_stack_.pop_back();
-
+
return *this;
}
// End code for XHTMLStream
namespace {
-
-// convenience functions
-
-inline void openTag(XHTMLStream & xs, Layout const & lay)
-{
- xs << html::StartTag(lay.htmltag(), lay.htmlattr());
-}
-
-
-void openTag(XHTMLStream & xs, Layout const & lay,
- ParagraphParameters const & params)
-{
- // FIXME Are there other things we should handle here?
- string const align = alignmentToCSS(params.align());
- if (align.empty()) {
- openTag(xs, lay);
- return;
- }
- string attrs = lay.htmlattr() + " style='text-align: " + align + ";'";
- xs << html::StartTag(lay.htmltag(), attrs);
-}
+// convenience functions
inline void openParTag(XHTMLStream & xs, Layout const & lay,
std::string parlabel)
}
-void openItemTag(XHTMLStream & xs, Layout const & lay,
+void openItemTag(XHTMLStream & xs, Layout const & lay,
ParagraphParameters const & params)
{
// FIXME Are there other things we should handle here?
ParagraphList::const_iterator findEndOfEnvironment(
- ParagraphList::const_iterator const pstart,
+ ParagraphList::const_iterator const & pstart,
ParagraphList::const_iterator const & pend)
{
ParagraphList::const_iterator p = pstart;
// 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())
+
+ // FIXME I am not sure about the first check.
+ // Surely we *could* have different layouts that count as
+ // LATEX_PARAGRAPH, right?
+ if (style.latextype == LATEX_PARAGRAPH || style != bstyle)
return p;
}
return pend;
if (!lay.counter.empty())
buf.masterBuffer()->params().
documentClass().counters().step(lay.counter, OutputUpdate);
+
// FIXME We should see if there's a label to be output and
// do something with it.
if (par != pbegin)
xs << html::CR();
- // If we are already in a paragraph, and this is the first one, then we
- // do not want to open the paragraph tag.
- // we also do not want to open it if the current layout does not permit
- // multiple paragraphs.
- bool const opened = runparams.html_make_pars &&
- (par != pbegin || !runparams.html_in_par);
- bool const make_parid = !runparams.for_toc && runparams.html_make_pars;
-
- if (opened)
- openParTag(xs, lay, par->params(),
- make_parid ? par->magicLabel() : "");
+ // We want to open the paragraph tag if:
+ // (i) the current layout permits multiple paragraphs
+ // (ii) we are either not already inside a paragraph (HTMLIsBlock) OR
+ // we are, but this is not the first paragraph
+ //
+ // But there is also a special case, and we first see whether we are in it.
+ // We do not want to open the paragraph tag if this paragraph contains
+ // only one item, and that item is "inline", i.e., not HTMLIsBlock (such
+ // as a branch). On the other hand, if that single item has a font change
+ // applied to it, then we still do need to open the paragraph.
+ //
+ // Obviously, this is very fragile. The main reason we need to do this is
+ // because of branches, e.g., a branch that contains an entire new section.
+ // We do not really want to wrap that whole thing in a <div>...</div>.
+ bool special_case = false;
+ Inset const * specinset = par->size() == 1 ? par->getInset(0) : 0;
+ if (specinset && !specinset->getLayout().htmlisblock()) {
+ Layout const & style = par->layout();
+ FontInfo const first_font = style.labeltype == LABEL_MANUAL ?
+ style.labelfont : style.font;
+ FontInfo const our_font =
+ par->getFont(buf.masterBuffer()->params(), 0,
+ text.outerFont(distance(begin, par))).fontInfo();
+ if (first_font == our_font)
+ special_case = true;
+ }
- docstring const deferred =
- par->simpleLyXHTMLOnePar(buf, xs, runparams, text.outerFont(distance(begin, par)));
+ bool const open_par = runparams.html_make_pars
+ && (!runparams.html_in_par || par != pbegin)
+ && !special_case;
// We want to issue the closing tag if either:
// (i) We opened it, and either html_in_par is false,
// or we're not in the last paragraph, anyway.
- // (ii) We didn't open it and html_in_par is true,
+ // (ii) We didn't open it and html_in_par is true,
// but we are in the first par, and there is a next par.
ParagraphList::const_iterator nextpar = par;
++nextpar;
- bool const needclose =
- (opened && (!runparams.html_in_par || nextpar != pend))
- || (!opened && runparams.html_in_par && par == pbegin && nextpar != pend);
- if (needclose) {
+ bool const close_par =
+ (open_par && (!runparams.html_in_par || nextpar != pend))
+ || (!open_par && runparams.html_in_par && par == pbegin && nextpar != pend);
+
+ if (open_par) {
+ // We do not issue the paragraph id if we are doing
+ // this for the TOC (or some similar purpose)
+ openParTag(xs, lay, par->params(),
+ runparams.for_toc ? "" : par->magicLabel());
+ }
+
+ docstring const deferred = par->simpleLyXHTMLOnePar(buf, xs,
+ runparams, text.outerFont(distance(begin, par)),
+ open_par, close_par);
+
+ if (close_par) {
closeTag(xs, lay);
xs << html::CR();
}
+
if (!deferred.empty()) {
xs << XHTMLStream::ESCAPE_NONE << deferred << html::CR();
}
OutputParams const & runparams,
Text const & text,
ParagraphList::const_iterator const & pbegin,
- ParagraphList::const_iterator const & pend)
+ ParagraphList::const_iterator const & pend)
{
// FIXME XHTML
// Use TextClass::htmlTOCLayout() to figure out how we should look.
|| lay.latextype == LATEX_BIB_ENVIRONMENT;
}
-
+
ParagraphList::const_iterator makeEnvironment(Buffer const & buf,
XHTMLStream & xs,
OutputParams const & runparams,
Text const & text,
ParagraphList::const_iterator const & pbegin,
- ParagraphList::const_iterator const & pend)
+ ParagraphList::const_iterator const & pend)
{
ParagraphList::const_iterator const begin = text.paragraphs().begin();
ParagraphList::const_iterator par = pbegin;
// "ii", etc, as with enum.
Counters & cnts = buf.masterBuffer()->params().documentClass().counters();
docstring const & cntr = style.counter;
- if (!style.counter.empty()
- && (par == pbegin || !isNormalEnv(style))
+ if (!style.counter.empty()
+ && (par == pbegin || !isNormalEnv(style))
&& cnts.hasCounter(cntr)
)
cnts.step(cntr, OutputUpdate);
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
+ // 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) {
LATTEST(bstyle == style);
closeItemTag(xs, *lastlay);
lastlay = 0;
}
-
+
+ // this will be positive, if we want to skip the
+ // initial word (if it's been taken for the label).
+ pos_type sep = 0;
bool const labelfirst = style.htmllabelfirst();
if (!labelfirst)
openItemTag(xs, style, par->params());
-
+
// label output
- if (style.labeltype != LABEL_NO_LABEL &&
+ if (style.labeltype != LABEL_NO_LABEL &&
style.htmllabeltag() != "NONE") {
if (isNormalEnv(style)) {
- // in this case, we print the label only for the first
+ // in this case, we print the label only for the first
// paragraph (as in a theorem).
if (par == pbegin) {
- docstring const lbl =
+ docstring const lbl =
pbegin->params().labelString();
if (!lbl.empty()) {
openLabelTag(xs, style);
}
xs << html::CR();
}
- } else { // some kind of list
+ } else { // some kind of list
if (style.labeltype == LABEL_MANUAL) {
openLabelTag(xs, style);
sep = par->firstWordLyXHTML(xs, runparams);
if (labelfirst)
openItemTag(xs, style, par->params());
- par->simpleLyXHTMLOnePar(buf, xs, runparams,
- text.outerFont(distance(begin, par)), sep);
+ docstring deferred = par->simpleLyXHTMLOnePar(buf, xs, runparams,
+ text.outerFont(distance(begin, par)), true, true, sep);
+ xs << XHTMLStream::ESCAPE_NONE << deferred;
++par;
// We may not want to close the tag yet, in particular:
// If we're not at the end...
- if (par != pend
+ if (par != pend
// and are doing items...
&& !isNormalEnv(style)
// and if the depth has changed...
documentClass().counters().step(style.counter, OutputUpdate);
bool const make_parid = !runparams.for_toc && runparams.html_make_pars;
+
+ if (style.labeltype == LABEL_ABOVE)
+ xs << html::StartTag("div")
+ << pbegin->params().labelString()
+ << html::EndTag("div");
+ else if (style.labeltype == LABEL_CENTERED)
+ xs << html::StartTag("div", "style = \"text-align: center;\"")
+ << pbegin->params().labelString()
+ << html::EndTag("div");
openParTag(xs, style, pbegin->params(),
make_parid ? pbegin->magicLabel() : "");
// Label around sectioning number:
// FIXME Probably need to account for LABEL_MANUAL
- // FIXME Probably also need now to account for labels ABOVE and CENTERED.
- if (style.labeltype != LABEL_NO_LABEL) {
+ if (style.labeltype != LABEL_NO_LABEL &&
+ style.labeltype != LABEL_ABOVE &&
+ style.labeltype != LABEL_CENTERED ) {
openLabelTag(xs, style);
xs << pbegin->params().labelString();
closeLabelTag(xs, style);
case LATEX_COMMAND: {
// The files with which we are working never have more than
// one paragraph in a command structure.
- // FIXME
+ // FIXME
// if (ourparams.html_in_par)
// fix it so we don't get sections inside standard, e.g.
// note that we may then need to make runparams not const, so we