X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.cpp;h=d8299ce5c4511a30df32133583a5f86fde4c6aa1;hb=fa8dae4201fc25da685a21de0f8968678df8f119;hp=59818db87b3e6e9a759c88711fffedc9285df448;hpb=7aebcc787fafbcedae6d2eccf63cc55436f6eb58;p=lyx.git diff --git a/src/output_xhtml.cpp b/src/output_xhtml.cpp index 59818db87b..d8299ce5c4 100644 --- a/src/output_xhtml.cpp +++ b/src/output_xhtml.cpp @@ -18,6 +18,7 @@ #include "buffer_funcs.h" #include "BufferParams.h" #include "Counters.h" +#include "Font.h" #include "Layout.h" #include "OutputParams.h" #include "Paragraph.h" @@ -27,9 +28,11 @@ #include "Text.h" #include "TextClass.h" -#include "support/lassert.h" +#include "support/convert.h" #include "support/debug.h" +#include "support/lassert.h" #include "support/lstrings.h" +#include "support/textutils.h" #include @@ -75,18 +78,76 @@ docstring htmlize(docstring const & str) { } +string escapeChar(char c) +{ + string str; + switch (c) { + case ' ': + str += " "; + break; + case '&': + str += "&"; + break; + case '<': + str += "<"; + break; + case '>': + str += ">"; + break; + default: + str += c; + break; + } + return str; +} + + +// escape what needs escaping +string htmlize(string const & str) { + ostringstream d; + string::const_iterator it = str.begin(); + string::const_iterator en = str.end(); + for (; it != en; ++it) + d << escapeChar(*it); + 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 += isalnum(*it) ? *it : '_'; + return newname; +} + + +docstring cleanAttr(docstring const & str) +{ + docstring newname; + docstring::const_iterator it = str.begin(); + docstring::const_iterator en = str.end(); + for (; it != en; ++it) { + char_type const c = *it; + newname += isAlnumASCII(c) ? c : char_type('_'); + } + return newname; +} + + bool isFontTag(string const & s) { return s == "em" || s == "strong"; // others? } -} // namespace html docstring StartTag::asTag() const { string output = "<" + tag_; if (!attr_.empty()) - output += " " + attr_; + output += " " + html::htmlize(attr_); output += ">"; return from_utf8(output); } @@ -110,11 +171,14 @@ docstring CompTag::asTag() const { string output = "<" + tag_; if (!attr_.empty()) - output += " " + attr_; + output += " " + html::htmlize(attr_); output += " />"; return from_utf8(output); } +} // namespace html + + //////////////////////////////////////////////////////////////// /// @@ -123,7 +187,7 @@ docstring CompTag::asTag() const //////////////////////////////////////////////////////////////// XHTMLStream::XHTMLStream(odocstream & os) - :os_(os) + : os_(os), nextraw_(false) {} @@ -134,10 +198,19 @@ void XHTMLStream::cr() } +void XHTMLStream::writeError(std::string const & s) +{ + LYXERR0(s); + os_ << from_utf8(""); +} + + bool XHTMLStream::closeFontTags() { + if (tag_stack_.empty()) + return true; // first, we close any open font tags we can close - StartTag curtag = tag_stack_.back(); + html::StartTag curtag = tag_stack_.back(); while (html::isFontTag(curtag.tag_)) { os_ << curtag.asEndTag(); tag_stack_.pop_back(); @@ -155,7 +228,8 @@ bool XHTMLStream::closeFontTags() bool noFontTags = true; for (; it != en; ++it) { if (html::isFontTag(it->tag_)) { - LYXERR0("Font tag `" << it->tag_ << "' still open in closeFontTags()."); + writeError("Font tag `" + it->tag_ + "' still open in closeFontTags().\n" + "This is likely not a problem, but you might want to check."); noFontTags = false; } } @@ -166,7 +240,7 @@ bool XHTMLStream::closeFontTags() void XHTMLStream::clearTagDeque() { while (!pending_tags_.empty()) { - StartTag const & tag = pending_tags_.front(); + html::StartTag const & tag = pending_tags_.front(); // tabs? os_ << tag.asTag(); tag_stack_.push_back(tag); @@ -174,11 +248,28 @@ void XHTMLStream::clearTagDeque() } } + XHTMLStream & XHTMLStream::operator<<(docstring const & d) { - // I'm tempted to make sure here that there are no tags in the input clearTagDeque(); - os_ << html::htmlize(d); + if (nextraw_) { + os_ << d; + nextraw_ = false; + } else + os_ << html::htmlize(d); + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(const char * s) +{ + clearTagDeque(); + docstring const d = from_ascii(s); + if (nextraw_) { + os_ << d; + nextraw_ = false; + } else + os_ << html::htmlize(d); return *this; } @@ -186,13 +277,49 @@ XHTMLStream & XHTMLStream::operator<<(docstring const & d) XHTMLStream & XHTMLStream::operator<<(char_type c) { clearTagDeque(); - os_ << html::escapeChar(c); + if (nextraw_) { + os_ << c; + nextraw_ = false; + } else + os_ << html::escapeChar(c); + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(char c) +{ + clearTagDeque(); + if (nextraw_) { + os_ << c; + nextraw_ = false; + } else { + string const d = html::escapeChar(c); + os_ << from_ascii(d); + } + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(int i) +{ + clearTagDeque(); + os_ << i; + nextraw_ = false; return *this; } -XHTMLStream & XHTMLStream::operator<<(StartTag const & tag) +XHTMLStream & XHTMLStream::operator<<(NextRaw const &) +{ + nextraw_ = true; + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(html::StartTag const & tag) { + if (tag.tag_.empty()) + return *this; pending_tags_.push_back(tag); if (tag.keepempty_) clearTagDeque(); @@ -200,21 +327,23 @@ XHTMLStream & XHTMLStream::operator<<(StartTag const & tag) } -XHTMLStream & XHTMLStream::operator<<(CompTag const & tag) +XHTMLStream & XHTMLStream::operator<<(html::CompTag const & tag) { + if (tag.tag_.empty()) + return *this; clearTagDeque(); // tabs? os_ << tag.asTag(); + cr(); return *this; } -bool XHTMLStream::isTagOpen(string const & stag) +bool XHTMLStream::isTagOpen(string const & stag) { TagStack::const_iterator sit = tag_stack_.begin(); TagStack::const_iterator const sen = tag_stack_.end(); for (; sit != sen; ++sit) - // we could check for the if (sit->tag_ == stag) return true; return false; @@ -226,11 +355,21 @@ bool XHTMLStream::isTagOpen(string const & stag) // 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. -XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) +XHTMLStream & XHTMLStream::operator<<(html::EndTag const & etag) { + if (etag.tag_.empty()) + return *this; + + // make sure there are tags to be closed + if (tag_stack_.empty()) { + writeError("Tried to close `" + etag.tag_ + + "' when no tags were open!"); + return *this; + } + // first make sure we're not closing an empty tag if (!pending_tags_.empty()) { - StartTag const & stag = pending_tags_.back(); + html::StartTag const & stag = pending_tags_.back(); if (etag.tag_ == stag.tag_) { // we have , so we discard it and remove it // from the pending_tags_. @@ -246,25 +385,27 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) for (; dit != den; ++dit) { if (dit->tag_ == etag.tag_) { // it was pending, so we just erase it - LYXERR0("Tried to close pending tag `" << etag.tag_ - << "' when other tags were pending. Tag discarded."); + writeError("Tried to close pending tag `" + etag.tag_ + + "' when other tags were pending. Last pending tag is `" + + pending_tags_.back().tag_ + "'. Tag discarded."); pending_tags_.erase(dit); return *this; } } // so etag isn't itself pending. is it even open? if (!isTagOpen(etag.tag_)) { - LYXERR0("Tried to close `" << etag.tag_ - << "' when tag was not open. Tag discarded."); + 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 // do to close this tag. - LYXERR0("Closing tag `" << etag.tag_ - << "' when other tags are pending. Discarded pending tags:"); + string estr = "Closing tag `" + etag.tag_ + + "' when other tags are pending. Discarded pending tags:\n"; for (dit = pending_tags_.begin(); dit != den; ++dit) - LYXERR0(dit->tag_); + estr += dit->tag_ + "\n"; + writeError(estr); // clear the pending tags... pending_tags_.clear(); // ...and then just fall through. @@ -282,8 +423,8 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) // 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.tag_)) { - LYXERR0("Tried to close `" << etag.tag_ - << "' when tag was not open. Tag discarded."); + writeError("Tried to close `" + etag.tag_ + + "' when tag was not open. Tag discarded."); return *this; } @@ -296,10 +437,12 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) TagStack::const_reverse_iterator rit = tag_stack_.rbegin(); TagStack::const_reverse_iterator ren = tag_stack_.rend(); for (; rit != ren; ++rit) { + if (rit->tag_ == etag.tag_) + break; if (!html::isFontTag(rit->tag_)) { // we'll just leave it and, presumably, have to close it later. - LYXERR0("Unable to close font tag `" << etag.tag_ - << "' due to open non-font tags."); + writeError("Unable to close font tag `" + etag.tag_ + + "' due to open non-font tag `" + rit->tag_ + "'."); return *this; } } @@ -309,7 +452,7 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) // and are being asked to closed em. we want: // this is bold // first, we close the intervening tags... - StartTag curtag = tag_stack_.back(); + html::StartTag curtag = tag_stack_.back(); // ...remembering them in a stack. TagStack fontstack; while (curtag.tag_ != etag.tag_) { @@ -320,6 +463,8 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) } // now close our tag... os_ << etag.asEndTag(); + tag_stack_.pop_back(); + // ...and restore the other tags. rit = fontstack.rbegin(); ren = fontstack.rend(); @@ -332,11 +477,11 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) // 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. - LYXERR0("Closing tag `" << etag.tag_ - << "' when other tags are open, namely:"); - StartTag curtag = tag_stack_.back(); + writeError("Closing tag `" + etag.tag_ + + "' when other tags are open, namely:"); + html::StartTag curtag = tag_stack_.back(); while (curtag.tag_ != etag.tag_) { - LYXERR0(curtag.tag_); + writeError(curtag.tag_); os_ << curtag.asEndTag(); tag_stack_.pop_back(); curtag = tag_stack_.back(); @@ -356,37 +501,65 @@ namespace { inline void openTag(XHTMLStream & xs, Layout const & lay) { - xs << StartTag(lay.htmltag(), lay.htmlattr()); + 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); } inline void closeTag(XHTMLStream & xs, Layout const & lay) { - xs << EndTag(lay.htmltag()); + xs << html::EndTag(lay.htmltag()); } inline void openLabelTag(XHTMLStream & xs, Layout const & lay) { - xs << StartTag(lay.htmllabeltag(), lay.htmllabelattr()); + xs << html::StartTag(lay.htmllabeltag(), lay.htmllabelattr()); } inline void closeLabelTag(XHTMLStream & xs, Layout const & lay) { - xs << EndTag(lay.htmllabeltag()); + xs << html::EndTag(lay.htmllabeltag()); } inline void openItemTag(XHTMLStream & xs, Layout const & lay) { - xs << StartTag(lay.htmlitemtag(), lay.htmlitemattr(), true); + xs << html::StartTag(lay.htmlitemtag(), lay.htmlitemattr(), true); +} + + +void openItemTag(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()) { + openItemTag(xs, lay); + return; + } + string attrs = lay.htmlattr() + " style='text-align: " + align + ";'"; + xs << html::StartTag(lay.htmlitemtag(), attrs); } inline void closeItemTag(XHTMLStream & xs, Layout const & lay) { - xs << EndTag(lay.htmlitemtag()); + xs << html::EndTag(lay.htmlitemtag()); } // end of convenience functions @@ -443,22 +616,22 @@ ParagraphList::const_iterator makeParagraphs(Buffer const & buf, for (; par != pend; ++par) { Layout const & lay = par->layout(); if (!lay.counter.empty()) - buf.params().documentClass().counters().step(lay.counter); + buf.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.cr(); - // FIXME Should we really allow anything other than 'p' here? - // If we are already in a paragraph, and this is the first one, then we // do not want to open the paragraph tag. - bool const opened = - (par == pbegin && runparams.html_in_par) ? false : true; + // 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); if (opened) - openTag(xs, lay); - docstring const deferred = from_ascii(""); -// par->simpleLyXHTMLOnePar(buf, os, runparams, text.outerFont(distance(begin, par))); + openTag(xs, lay, par->params()); + docstring const deferred = + par->simpleLyXHTMLOnePar(buf, xs, runparams, text.outerFont(distance(begin, par))); // We want to issue the closing tag if either: // (i) We opened it, and either html_in_par is false, @@ -475,7 +648,7 @@ ParagraphList::const_iterator makeParagraphs(Buffer const & buf, xs.cr(); } if (!deferred.empty()) { - xs << deferred; + xs << XHTMLStream::NextRaw() << deferred; xs.cr(); } } @@ -490,21 +663,24 @@ ParagraphList::const_iterator makeBibliography(Buffer const & buf, ParagraphList::const_iterator const & pbegin, ParagraphList::const_iterator const & pend) { - xs << StartTag("h2", "class='bibliography'"); + // FIXME XHTML + // Use TextClass::htmlTOCLayout() to figure out how we should look. + xs << html::StartTag("h2", "class='bibliography'"); xs << pbegin->layout().labelstring(false); - xs << EndTag("h2"); + xs << html::EndTag("h2"); xs.cr(); - xs << StartTag("div", "class='bibliography'"); + xs << html::StartTag("div", "class='bibliography'"); xs.cr(); makeParagraphs(buf, xs, runparams, text, pbegin, pend); - xs << EndTag("div"); + xs << html::EndTag("div"); return pend; } bool isNormalEnv(Layout const & lay) { - return lay.latextype == LATEX_ENVIRONMENT; + return lay.latextype == LATEX_ENVIRONMENT + || lay.latextype == LATEX_BIB_ENVIRONMENT; } @@ -531,8 +707,17 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, Layout const & style = par->layout(); // the counter only gets stepped if we're in some kind of list, // or if it's the first time through. - if (!style.counter.empty() && (par == pbegin || !isNormalEnv(style))) - buf.params().documentClass().counters().step(style.counter); + // note that enum, etc, are handled automatically. + // FIXME There may be a bug here about user defined enumeration + // types. If so, then we'll need to take the counter and add "i", + // "ii", etc, as with enum. + Counters & cnts = buf.params().documentClass().counters(); + docstring const & cntr = style.counter; + 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). @@ -551,53 +736,55 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, closeItemTag(xs, *lastlay); lastlay = 0; } + bool const labelfirst = style.htmllabelfirst(); - if (isNormalEnv(style)) { - // in this case, we print the label only for the first - // paragraph (as in a theorem). - openItemTag(xs, style); - if (par == pbegin && style.htmllabeltag() != "NONE") { - docstring const lbl = - pbegin->expandLabel(style, buf.params(), false); - if (!lbl.empty()) { + if (!labelfirst) + openItemTag(xs, style, par->params()); + + // label output + if (style.labeltype != LABEL_NO_LABEL && + style.htmllabeltag() != "NONE") { + if (isNormalEnv(style)) { + // in this case, we print the label only for the first + // paragraph (as in a theorem). + if (par == pbegin) { + docstring const lbl = + pbegin->params().labelString(); + if (!lbl.empty()) { + openLabelTag(xs, style); + xs << lbl; + closeLabelTag(xs, style); + } + xs.cr(); + } + } else { // some kind of list + if (style.labeltype == LABEL_MANUAL) { openLabelTag(xs, style); - xs << lbl; + sep = par->firstWordLyXHTML(xs, runparams); closeLabelTag(xs, style); + xs.cr(); + } + else { + openLabelTag(xs, style); + xs << par->params().labelString(); + closeLabelTag(xs, style); + xs.cr(); } - xs.cr(); - } - } else { // some kind of list - if (!labelfirst) - openItemTag(xs, style); - if (style.labeltype == LABEL_MANUAL - && style.htmllabeltag() != "NONE") { - openLabelTag(xs, style); -// sep = par->firstWordLyXHTML(xs, runparams); - closeLabelTag(xs, style); - xs.cr(); - } - else if (style.labeltype != LABEL_NO_LABEL - && style.htmllabeltag() != "NONE") { - openLabelTag(xs, style); - xs << par->expandLabel(style, buf.params(), false); - closeLabelTag(xs, style); - xs.cr(); } - if (labelfirst) - openItemTag(xs, style); - else - xs << StartTag("span", "class='" + to_utf8(style.name()) + " inneritem'>"); - } -// par->simpleLyXHTMLOnePar(buf, os, runparams, -// text.outerFont(distance(begin, par)), sep); - if (!isNormalEnv(style) && !labelfirst) - xs << EndTag("span"); + } // end label output + + if (labelfirst) + openItemTag(xs, style, par->params()); + + par->simpleLyXHTMLOnePar(buf, xs, runparams, + text.outerFont(distance(begin, par)), sep); ++par; - // We may not want to close the tag yet, in particular, - // if we're not at the end... + + // 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 + && !isNormalEnv(style) // and if the depth has changed... && par->params().depth() != origdepth) { // then we'll save this layout for later, and close it when @@ -648,23 +835,23 @@ void makeCommand(Buffer const & buf, { Layout const & style = pbegin->layout(); if (!style.counter.empty()) - buf.params().documentClass().counters().step(style.counter); + buf.params().documentClass().counters().step(style.counter, OutputUpdate); - openTag(xs, style); + openTag(xs, style, pbegin->params()); // Label around sectioning number: // FIXME Probably need to account for LABEL_MANUAL if (style.labeltype != LABEL_NO_LABEL) { openLabelTag(xs, style); - xs << pbegin->expandLabel(style, buf.params(), false); + xs << pbegin->params().labelString(); closeLabelTag(xs, style); // Otherwise the label might run together with the text xs << from_ascii(" "); } ParagraphList::const_iterator const begin = text.paragraphs().begin(); -// pbegin->simpleLyXHTMLOnePar(buf, os, runparams, -// text.outerFont(distance(begin, pbegin))); + pbegin->simpleLyXHTMLOnePar(buf, xs, runparams, + text.outerFont(distance(begin, pbegin))); closeTag(xs, style); xs.cr(); } @@ -683,6 +870,13 @@ void xhtmlParagraphs(Text const & text, OutputParams ourparams = runparams; while (par != pend) { + if (par->params().startOfAppendix()) { + // FIXME: only the counter corresponding to toplevel + // sectioning should be reset + Counters & cnts = buf.masterBuffer()->params().documentClass().counters(); + cnts.reset(); + cnts.appendix(true); + } Layout const & style = par->layout(); ParagraphList::const_iterator lastpar = par; ParagraphList::const_iterator send; @@ -729,4 +923,20 @@ void xhtmlParagraphs(Text const & text, } +string alignmentToCSS(LyXAlignment align) { + switch (align) { + case LYX_ALIGN_BLOCK: + // we are NOT going to use text-align: justify!! + case LYX_ALIGN_LEFT: + return "left"; + case LYX_ALIGN_RIGHT: + return "right"; + case LYX_ALIGN_CENTER: + return "center"; + default: + break; + } + return ""; +} + } // namespace lyx