X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.cpp;h=0a0bfd3cbe328f105941b066eaf53e0552851a7d;hb=74c9165190133af19c95584e4922ed749db0f9fe;hp=d66b8fd915e6ef96657d3a5ca9f30a89281cfa59;hpb=8745fd6caa9620b587fe9a409d12b95b5dbdcd1e;p=lyx.git diff --git a/src/output_xhtml.cpp b/src/output_xhtml.cpp index d66b8fd915..0a0bfd3cbe 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,12 +28,17 @@ #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 +// Uncomment to activate debugging code. +// #define XHTML_DEBUG + using namespace std; using namespace lyx::support; @@ -40,149 +46,555 @@ namespace lyx { namespace html { -docstring escapeChar(char_type c) +docstring escapeChar(char_type c, XHTMLStream::EscapeSettings e) { docstring str; - switch (c) { - case ' ': - str += " "; - break; - case '&': - str += "&"; - break; - case '<': - str += "<"; - break; - case '>': - str += ">"; - break; - default: + 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 -docstring htmlize(docstring const & str) { +docstring htmlize(docstring const & str, XHTMLStream::EscapeSettings e) +{ odocstringstream d; docstring::const_iterator it = str.begin(); docstring::const_iterator en = str.end(); for (; it != en; ++it) - d << escapeChar(*it); + d << escapeChar(*it, e); + return d.str(); +} + + +string 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(); } -bool isFontTag(string const & s) +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; +} + + +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; +} + + +docstring StartTag::writeTag() const { - return s == "em" || s == "strong"; // others? + string output = "<" + tag_; + if (!attr_.empty()) + output += " " + html::htmlize(attr_, XHTMLStream::ESCAPE_NONE); + output += ">"; + return from_utf8(output); } +docstring StartTag::writeEndTag() const +{ + string output = ""; + return from_utf8(output); +} + + +bool StartTag::operator==(FontTag const & rhs) const +{ + return rhs == *this; +} + + +docstring EndTag::writeEndTag() const +{ + string output = ""; + return from_utf8(output); +} + + +docstring ParTag::writeTag() const +{ + docstring output = StartTag::writeTag(); + + if (parid_.empty()) + return output; + + string const pattr = "id='" + parid_ + "'"; + output += html::CompTag("a", pattr).writeTag(); + return output; +} + + +docstring CompTag::writeTag() const +{ + string output = "<" + tag_; + if (!attr_.empty()) + output += " " + html::htmlize(attr_, XHTMLStream::ESCAPE_NONE); + output += " />"; + return from_utf8(output); +} + + + +namespace { + +string fontToTag(html::FontTypes type) + { + switch(type) { + case FT_EMPH: + return "em"; + case FT_BOLD: + return "b"; + case FT_NOUN: + return "dfn"; + case FT_UBAR: + case FT_WAVE: + case FT_DBAR: + return "u"; + case FT_SOUT: + return "del"; + case FT_ITALIC: + return "i"; + case FT_UPRIGHT: + case FT_SLANTED: + case FT_SMALLCAPS: + 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); + switch(type) { + case FT_EMPH: + return html::StartTag(tag); + case FT_BOLD: + return html::StartTag(tag); + case FT_NOUN: + return html::StartTag(tag, "class='lyxnoun'"); + case FT_UBAR: + return html::StartTag(tag); + case FT_DBAR: + return html::StartTag(tag, "class='dline'"); + case FT_SOUT: + return html::StartTag(tag, "class='strikeout'"); + case FT_WAVE: + return html::StartTag(tag, "class='wline'"); + case FT_ITALIC: + return html::StartTag(tag); + case FT_UPRIGHT: + return html::StartTag(tag, "style='font-style:normal;'"); + case FT_SLANTED: + return html::StartTag(tag, "style='font-style:oblique;'"); + case FT_SMALLCAPS: + return html::StartTag(tag, "style='font-variant:small-caps;'"); + case FT_ROMAN: + return html::StartTag(tag, "style='font-family:serif;'"); + case FT_SANS: + return html::StartTag(tag, "style='font-family:sans-serif;'"); + case FT_TYPE: + return html::StartTag(tag, "style='font-family:monospace;'"); + case FT_SIZE_TINY: + case FT_SIZE_SCRIPT: + case FT_SIZE_FOOTNOTE: + return html::StartTag(tag, "style='font-size:x-small;'"); + case FT_SIZE_SMALL: + return html::StartTag(tag, "style='font-size:small;'"); + case FT_SIZE_NORMAL: + return html::StartTag(tag, "style='font-size:normal;'"); + case FT_SIZE_LARGE: + return html::StartTag(tag, "style='font-size:large;'"); + case FT_SIZE_LARGER: + case FT_SIZE_LARGEST: + return html::StartTag(tag, "style='font-size:x-large;'"); + case FT_SIZE_HUGE: + case FT_SIZE_HUGER: + return html::StartTag(tag, "style='font-size:xx-large;'"); + case FT_SIZE_INCREASE: + return html::StartTag(tag, "style='font-size:larger;'"); + case FT_SIZE_DECREASE: + return html::StartTag(tag, "style='font-size:smaller;'"); + } + // kill warning + return StartTag(""); +} + +} // end anonymous namespace + + +FontTag::FontTag(FontTypes type) + : StartTag(fontToStartTag(type)), font_type_(type) +{} + + +bool FontTag::operator==(StartTag const & tag) const +{ + FontTag const * const ftag = tag.asFontTag(); + if (!ftag) + return false; + return (font_type_ == ftag->font_type_); +} + + +EndFontTag::EndFontTag(FontTypes type) + : EndTag(fontToTag(type)), font_type_(type) +{} + +} // namespace html + + + //////////////////////////////////////////////////////////////// /// /// XHTMLStream /// //////////////////////////////////////////////////////////////// -XHTMLStream::XHTMLStream(odocstream & os) - :os_(os) +XHTMLStream::XHTMLStream(odocstream & os) + : os_(os), escape_(ESCAPE_ALL) {} -void XHTMLStream::cr() +#ifdef XHTML_DEBUG +void XHTMLStream::dumpTagStack(string const & msg) const { - // tabs? - os_ << std::endl; + writeError(msg + ": Tag Stack"); + TagStack::const_reverse_iterator it = tag_stack_.rbegin(); + TagStack::const_reverse_iterator en = tag_stack_.rend(); + for (; it != en; ++it) { + writeError(it->tag_); + } + writeError("Pending Tags"); + it = pending_tags_.rbegin(); + en = pending_tags_.rend(); + for (; it != en; ++it) { + writeError(it->tag_); + } + writeError("End Tag Stack"); +} +#endif + + +void XHTMLStream::writeError(std::string const & s) const +{ + LYXERR0(s); + os_ << from_utf8("\n"); +} + + +namespace { + // an illegal tag for internal use + static html::StartTag const parsep_tag("&LyX_parsep_tag&"); } bool XHTMLStream::closeFontTags() { + if (isTagPending(parsep_tag)) + // we haven't had any content + return true; + + // 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()) + return true; + // first, we close any open font tags we can close - StartTag curtag = tag_stack_.back(); - while (isFontTag(curtag.tag_)) { - os_ << ""; + TagPtr curtag = tag_stack_.back(); + while (curtag->asFontTag()) { + os_ << curtag->writeEndTag(); tag_stack_.pop_back(); - if (tag_stack_.empty()) - // this probably shouldn't happen, since then the - // font tags weren't in any other tag. but that - // problem will likely be caught elsewhere. - return true; + // this shouldn't happen, since then the font tags + // weren't in any other tag. + LBUFERR(!tag_stack_.empty()); curtag = tag_stack_.back(); } - // so we've hit a non-font tag. let's see if any of the - // remaining tags are font tags. - TagStack::const_iterator it = tag_stack_.begin(); - TagStack::const_iterator en = tag_stack_.end(); - bool noFontTags = true; + + if (*curtag == parsep_tag) + return true; + + // so we've hit a non-font tag. + writeError("Tags still open in closeFontTags(). Probably not a problem,\n" + "but you might want to check these tags:"); + TagDeque::const_reverse_iterator it = tag_stack_.rbegin(); + TagDeque::const_reverse_iterator const en = tag_stack_.rend(); for (; it != en; ++it) { - if (isFontTag(it->tag_)) { - LYXERR0("Font tag `" << it->tag_ << "' still open in closeFontTags()."); - noFontTags = false; + if (**it == parsep_tag) + break; + writeError((*it)->tag_); + } + return false; +} + + +void XHTMLStream::startParagraph(bool keep_empty) +{ + pending_tags_.push_back(makeTagPtr(html::StartTag(parsep_tag))); + if (keep_empty) + clearTagDeque(); +} + + +void XHTMLStream::endParagraph() +{ + if (isTagPending(parsep_tag)) { + // this case is normal. it just means we didn't have content, + // so the parsep_tag never got moved onto the tag stack. + while (!pending_tags_.empty()) { + // clear all pending tags up to and including the parsep tag. + // note that we work from the back, because we want to get rid + // of everything that hasn't been used. + TagPtr const cur_tag = pending_tags_.back(); + pending_tags_.pop_back(); + if (*cur_tag == parsep_tag) + break; } + return; + } + + if (!isTagOpen(parsep_tag)) { + writeError("No paragraph separation tag found in endParagraph()."); + return; + } + + // 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(); + tag_stack_.pop_back(); + if (*cur_tag == parsep_tag) + break; + writeError("Tag `" + cur_tag->tag_ + "' still open at end of paragraph. Closing."); + os_ << cur_tag->writeEndTag(); } - return noFontTags; } void XHTMLStream::clearTagDeque() { while (!pending_tags_.empty()) { - StartTag const & tag = pending_tags_.front(); - // tabs? - os_ << "<" << tag.tag_ << " " << tag.attr_ << ">"; + TagPtr const tag = pending_tags_.front(); + if (*tag != parsep_tag) + // tabs? + os_ << tag->writeTag(); tag_stack_.push_back(tag); pending_tags_.pop_front(); } } + XHTMLStream & XHTMLStream::operator<<(docstring const & d) { - // I'm tempted to make sure here that there are no tags in the input clearTagDeque(); - os_ << htmlize(d); + os_ << html::htmlize(d, escape_); + escape_ = ESCAPE_ALL; + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(const char * s) +{ + clearTagDeque(); + docstring const d = from_ascii(s); + os_ << html::htmlize(d, escape_); + escape_ = ESCAPE_ALL; return *this; } -/* XHTMLStream & XHTMLStream::operator<<(char_type c) { clearTagDeque(); - os_ << escapeChar(c); + os_ << html::escapeChar(c, escape_); + escape_ = ESCAPE_ALL; + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(char c) +{ + clearTagDeque(); + string const d = html::escapeChar(c, escape_); + escape_ = ESCAPE_ALL; + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(int i) +{ + clearTagDeque(); + os_ << i; + escape_ = ESCAPE_ALL; + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(EscapeSettings e) +{ + escape_ = e; return *this; } -*/ -XHTMLStream & XHTMLStream::operator<<(StartTag const & tag) +XHTMLStream & XHTMLStream::operator<<(html::StartTag const & tag) { - pending_tags_.push_back(tag); + if (tag.tag_.empty()) + return *this; + pending_tags_.push_back(makeTagPtr(tag)); if (tag.keepempty_) clearTagDeque(); return *this; } -XHTMLStream & XHTMLStream::operator<<(CompTag const & tag) +XHTMLStream & XHTMLStream::operator<<(html::ParTag const & tag) { + if (tag.tag_.empty()) + return *this; + pending_tags_.push_back(makeTagPtr(tag)); + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(html::CompTag const & tag) +{ + if (tag.tag_.empty()) + return *this; clearTagDeque(); + os_ << tag.writeTag(); + *this << html::CR(); + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(html::FontTag const & tag) +{ + if (tag.tag_.empty()) + return *this; + pending_tags_.push_back(makeTagPtr(tag)); + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(html::CR const &) +{ // tabs? - os_ << "<" << tag.tag_ << " " << tag.attr_ << " />"; + os_ << from_ascii("\n"); return *this; } -bool XHTMLStream::isTagOpen(string const & stag) +bool XHTMLStream::isTagOpen(html::StartTag const & stag) const { - TagStack::const_iterator sit = tag_stack_.begin(); - TagStack::const_iterator const sen = tag_stack_.end(); + TagDeque::const_iterator sit = tag_stack_.begin(); + TagDeque::const_iterator const sen = tag_stack_.end(); for (; sit != sen; ++sit) - // we could check for the - if (sit->tag_ == stag) + if (**sit == stag) + return true; + return false; +} + + +bool XHTMLStream::isTagOpen(html::EndTag const & etag) const +{ + TagDeque::const_iterator sit = tag_stack_.begin(); + TagDeque::const_iterator const sen = tag_stack_.end(); + for (; sit != sen; ++sit) + if (etag == **sit) + return true; + return false; +} + + +bool XHTMLStream::isTagPending(html::StartTag const & stag) const +{ + TagDeque::const_iterator sit = pending_tags_.begin(); + TagDeque::const_iterator const sen = pending_tags_.end(); + for (; sit != sen; ++sit) + if (**sit == stag) return true; return false; } @@ -193,54 +605,69 @@ 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) { - // first make sure we're not closing an empty tag + if (etag.tag_.empty()) + return *this; + + // if this tag is pending, we can simply discard it. if (!pending_tags_.empty()) { - StartTag const & stag = pending_tags_.back(); - if (etag.tag_ == stag.tag_) { + + if (etag == *pending_tags_.back()) { // we have , 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. + // is this tag itself pending? // non-const iterators because we may call erase(). TagDeque::iterator dit = pending_tags_.begin(); TagDeque::iterator const den = pending_tags_.end(); for (; dit != den; ++dit) { - if (dit->tag_ == etag.tag_) { + if (etag == **dit) { // 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 `" + + 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.tag_)) { - LYXERR0("Tried to close `" << etag.tag_ - << "' when tag was not open. Tag discarded."); + if (!isTagOpen(etag)) { + 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 += to_utf8(html::htmlize((*dit)->writeTag(), XHTMLStream::ESCAPE_ALL)) + "\n"; + writeError(estr); // clear the pending tags... pending_tags_.clear(); // ...and then just fall through. } + // 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; + } + // is the tag we are closing the last one we opened? - if (etag.tag_ == tag_stack_.back().tag_) { + if (etag == *tag_stack_.back()) { // output it... - os_ << ""; + os_ << etag.writeEndTag(); // ...and forget about it tag_stack_.pop_back(); return *this; @@ -248,25 +675,27 @@ 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."); + if (!isTagOpen(etag)) { + 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... - if (isFontTag(etag.tag_)) { + if (etag.asFontTag()) { // it won't be a problem if the other tags open since this one // are also font tags. - TagStack::const_reverse_iterator rit = tag_stack_.rbegin(); - TagStack::const_reverse_iterator ren = tag_stack_.rend(); + TagDeque::const_reverse_iterator rit = tag_stack_.rbegin(); + TagDeque::const_reverse_iterator ren = tag_stack_.rend(); for (; rit != ren; ++rit) { - if (!isFontTag(rit->tag_)) { + if (etag == **rit) + break; + if (!(*rit)->asFontTag()) { // 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; } } @@ -276,17 +705,18 @@ 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(); + TagPtr curtag = tag_stack_.back(); // ...remembering them in a stack. - TagStack fontstack; - while (curtag.tag_ != etag.tag_) { - os_ << ""; + TagDeque fontstack; + while (etag != *curtag) { + os_ << curtag->writeEndTag(); fontstack.push_back(curtag); tag_stack_.pop_back(); curtag = tag_stack_.back(); } - // now close our tag... - os_ << ""; + os_ << etag.writeEndTag(); + tag_stack_.pop_back(); + // ...and restore the other tags. rit = fontstack.rbegin(); ren = fontstack.rend(); @@ -299,103 +729,97 @@ 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(); - while (curtag.tag_ != etag.tag_) { - LYXERR0(curtag.tag_); - os_ << ""; + writeError("Closing tag `" + etag.tag_ + + "' when other tags are open, namely:"); + TagPtr curtag = tag_stack_.back(); + while (etag != *curtag) { + writeError(curtag->tag_); + if (*curtag != parsep_tag) + os_ << curtag->writeEndTag(); tag_stack_.pop_back(); curtag = tag_stack_.back(); } // curtag is now the one we actually want. - os_ << ""; + os_ << curtag->writeEndTag(); tag_stack_.pop_back(); - + return *this; } +// End code for XHTMLStream -/////////////////////////////////////////////////////////////// -// OLD STUFF to be replaced +namespace { -// FIXME This needs to be protected somehow. -static vector taglist; +// convenience functions -bool openTag(odocstream & os, string const & tag, string const & attr) +inline void openParTag(XHTMLStream & xs, Layout const & lay, + std::string parlabel) { - if (tag.empty()) - return false; - os << from_ascii("<" + tag + (attr.empty() ? "" : " " + attr) + ">"); - taglist.push_back(tag); - return true; + xs << html::ParTag(lay.htmltag(), lay.htmlattr(), parlabel); } -bool closeTag(odocstream & os, string const & tag) +void openParTag(XHTMLStream & xs, Layout const & lay, + ParagraphParameters const & params, + std::string parlabel) { - 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; + // FIXME Are there other things we should handle here? + string const align = alignmentToCSS(params.align()); + if (align.empty()) { + openParTag(xs, lay, parlabel); + return; } - taglist.pop_back(); - os << from_ascii(""); - return true; + string attrs = lay.htmlattr() + " style='text-align: " + align + ";'"; + xs << html::ParTag(lay.htmltag(), attrs, parlabel); } - -} // html - -namespace { - -bool openTag(odocstream & os, Layout const & lay) +inline void closeTag(XHTMLStream & xs, Layout const & lay) { - return html::openTag(os, lay.htmltag(), lay.htmlattr()); + xs << html::EndTag(lay.htmltag()); } -bool closeTag(odocstream & os, Layout const & lay) +inline void openLabelTag(XHTMLStream & xs, Layout const & lay) { - return html::closeTag(os, lay.htmltag()); + xs << html::StartTag(lay.htmllabeltag(), lay.htmllabelattr()); } -bool openLabelTag(odocstream & os, Layout const & lay) +inline void closeLabelTag(XHTMLStream & xs, Layout const & lay) { - return html::openTag(os, lay.htmllabeltag(), lay.htmllabelattr()); + xs << html::EndTag(lay.htmllabeltag()); } -bool closeLabelTag(odocstream & os, Layout const & lay) +inline void openItemTag(XHTMLStream & xs, Layout const & lay) { - return html::closeTag(os, lay.htmllabeltag()); + xs << html::StartTag(lay.htmlitemtag(), lay.htmlitemattr(), true); } -bool openItemTag(odocstream & os, Layout const & lay) +void openItemTag(XHTMLStream & xs, Layout const & lay, + ParagraphParameters const & params) { - return html::openTag(os, lay.htmlitemtag(), lay.htmlitemattr()); + // 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); } -bool closeItemTag(odocstream & os, Layout const & lay) +inline void closeItemTag(XHTMLStream & xs, Layout const & lay) { - return html::closeTag(os, lay.htmlitemtag()); + xs << html::EndTag(lay.htmlitemtag()); } -// end of old stuff to be replaced -/////////////////////////////////////////////////////////////// +// end of convenience functions -ParagraphList::const_iterator searchParagraphHtml( +ParagraphList::const_iterator findLastParagraph( ParagraphList::const_iterator p, ParagraphList::const_iterator const & pend) { @@ -406,8 +830,8 @@ ParagraphList::const_iterator searchParagraphHtml( } -ParagraphList::const_iterator searchEnvironmentHtml( - ParagraphList::const_iterator const pstart, +ParagraphList::const_iterator findEndOfEnvironment( + ParagraphList::const_iterator const & pstart, ParagraphList::const_iterator const & pend) { ParagraphList::const_iterator p = pstart; @@ -420,15 +844,19 @@ ParagraphList::const_iterator searchEnvironmentHtml( // 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; @@ -436,7 +864,7 @@ ParagraphList::const_iterator searchEnvironmentHtml( ParagraphList::const_iterator makeParagraphs(Buffer const & buf, - odocstream & os, + XHTMLStream & xs, OutputParams const & runparams, Text const & text, ParagraphList::const_iterator const & pbegin, @@ -447,20 +875,27 @@ 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.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) - os << '\n'; + xs << html::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 : openTag(os, lay); - docstring const deferred = par->simpleLyXHTMLOnePar(buf, os, runparams, - text.outerFont(distance(begin, par))); + // 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() : ""); + + 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, @@ -468,47 +903,52 @@ ParagraphList::const_iterator makeParagraphs(Buffer const & buf, // (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 = + ++nextpar; + bool const needclose = (opened && (!runparams.html_in_par || nextpar != pend)) || (!opened && runparams.html_in_par && par == pbegin && nextpar != pend); - if (needClose) { - closeTag(os, lay); - os << '\n'; + if (needclose) { + closeTag(xs, lay); + xs << html::CR(); + } + if (!deferred.empty()) { + xs << XHTMLStream::ESCAPE_NONE << deferred << html::CR(); } - if (!deferred.empty()) - os << deferred << '\n'; } return pend; } ParagraphList::const_iterator makeBibliography(Buffer const & buf, - odocstream & os, + XHTMLStream & xs, OutputParams const & runparams, Text const & text, ParagraphList::const_iterator const & pbegin, ParagraphList::const_iterator const & pend) { - os << "

" - << pbegin->layout().labelstring(false) - << "

\n" - << "
\n"; - makeParagraphs(buf, os, runparams, text, pbegin, pend); - os << "
"; + // FIXME XHTML + // Use TextClass::htmlTOCLayout() to figure out how we should look. + xs << html::StartTag("h2", "class='bibliography'") + << pbegin->layout().labelstring(false) + << html::EndTag("h2") + << html::CR() + << html::StartTag("div", "class='bibliography'") + << html::CR(); + makeParagraphs(buf, xs, runparams, text, pbegin, pend); + xs << html::EndTag("div"); return pend; } -namespace { - bool isNormalEnv(Layout const & lay) - { - return lay.latextype == LATEX_ENVIRONMENT; - } +bool isNormalEnv(Layout const & lay) +{ + return lay.latextype == LATEX_ENVIRONMENT + || lay.latextype == LATEX_BIB_ENVIRONMENT; } -ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, - odocstream & os, + +ParagraphList::const_iterator makeEnvironment(Buffer const & buf, + XHTMLStream & xs, OutputParams const & runparams, Text const & text, ParagraphList::const_iterator const & pbegin, @@ -519,9 +959,9 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, 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'; + // open tag for this environment + openParTag(xs, bstyle, pbegin->magicLabel()); + xs << html::CR(); // we will on occasion need to remember a layout from before. Layout const * lastlay = 0; @@ -530,8 +970,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.masterBuffer()->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). @@ -545,91 +994,86 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, // 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) { - LASSERT(bstyle == style, /* */); + LATTEST(bstyle == style); if (lastlay != 0) { - closeItemTag(os, *lastlay); + closeItemTag(xs, *lastlay); lastlay = 0; } - bool item_tag_opened = false; + bool const labelfirst = style.htmllabelfirst(); - bool madelabel = false; - if (isNormalEnv(style)) { - // in this case, we print the label only for the first - // paragraph (as in a theorem). - item_tag_opened = openItemTag(os, style); - if (par == pbegin && style.htmllabeltag() != "NONE") { - docstring const lbl = - pbegin->expandLabel(style, buf.params(), false); - if (!lbl.empty()) { - bool const label_tag_opened = openLabelTag(os, style); - os << lbl; - if (label_tag_opened) - closeLabelTag(os, style); + 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 << html::CR(); + } + } else { // some kind of list + if (style.labeltype == LABEL_MANUAL) { + openLabelTag(xs, style); + sep = par->firstWordLyXHTML(xs, runparams); + closeLabelTag(xs, style); + xs << html::CR(); + } + else { + openLabelTag(xs, style); + xs << par->params().labelString(); + closeLabelTag(xs, style); + xs << html::CR(); } - os << '\n'; - } - } else { // some kind of list - if (!labelfirst) - item_tag_opened = openItemTag(os, style); - if (style.labeltype == LABEL_MANUAL - && style.htmllabeltag() != "NONE") { - madelabel = openLabelTag(os, style); - sep = par->firstWordLyXHTML(os, runparams); - if (madelabel) - closeLabelTag(os, style); - os << '\n'; - } - else if (style.labeltype != LABEL_NO_LABEL - && style.htmllabeltag() != "NONE") { - madelabel = openLabelTag(os, style); - os << par->expandLabel(style, buf.params(), false); - if (madelabel) - closeLabelTag(os, style); - os << '\n'; } - if (labelfirst) - item_tag_opened = openItemTag(os, style); - else if (madelabel) - os << ""; - } - par->simpleLyXHTMLOnePar(buf, os, runparams, + } // end label output + + if (labelfirst) + openItemTag(xs, style, par->params()); + + par->simpleLyXHTMLOnePar(buf, xs, runparams, text.outerFont(distance(begin, par)), sep); - if (!isNormalEnv(style) && !labelfirst && madelabel) - os << ""; ++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 = &style; - } else - closeItemTag(os, style); - os << '\n'; - } + + // 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... + && !isNormalEnv(style) + // 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 = &style; + } else + closeItemTag(xs, style); + xs << html::CR(); } // The other possibility is that the depth has increased, in which // case we need to recurse. else { - send = searchEnvironmentHtml(par, pend); - par = makeEnvironmentHtml(buf, os, runparams, text, par, send); + send = findEndOfEnvironment(par, pend); + par = makeEnvironment(buf, xs, runparams, text, par, send); } break; } case LATEX_PARAGRAPH: - send = searchParagraphHtml(par, pend); - par = makeParagraphs(buf, os, runparams, text, par, send); + send = findLastParagraph(par, pend); + par = makeParagraphs(buf, xs, runparams, text, par, send); break; // Shouldn't happen case LATEX_BIB_ENVIRONMENT: send = par; ++send; - par = makeParagraphs(buf, os, runparams, text, par, send); + par = makeParagraphs(buf, xs, runparams, text, par, send); break; // Shouldn't happen case LATEX_COMMAND: @@ -639,43 +1083,45 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, } if (lastlay != 0) - closeItemTag(os, *lastlay); - if (main_tag_opened) - closeTag(os, bstyle); - os << '\n'; + closeItemTag(xs, *lastlay); + closeTag(xs, bstyle); + xs << html::CR(); return pend; } void makeCommand(Buffer const & buf, - odocstream & os, - OutputParams const & runparams, - Text const & text, - ParagraphList::const_iterator const & pbegin) + XHTMLStream & xs, + OutputParams const & runparams, + Text const & text, + ParagraphList::const_iterator const & pbegin) { Layout const & style = pbegin->layout(); if (!style.counter.empty()) - buf.params().documentClass().counters().step(style.counter); + buf.masterBuffer()->params(). + documentClass().counters().step(style.counter, OutputUpdate); - bool const main_tag_opened = openTag(os, style); + bool const make_parid = !runparams.for_toc && runparams.html_make_pars; + + 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) { - bool const label_tag_opened = openLabelTag(os, style); - os << pbegin->expandLabel(style, buf.params(), false); - if (label_tag_opened) - closeLabelTag(os, style); + openLabelTag(xs, style); + xs << pbegin->params().labelString(); + closeLabelTag(xs, style); // Otherwise the label might run together with the text - os << ' '; + xs << from_ascii(" "); } ParagraphList::const_iterator const begin = text.paragraphs().begin(); - pbegin->simpleLyXHTMLOnePar(buf, os, runparams, + pbegin->simpleLyXHTMLOnePar(buf, xs, runparams, text.outerFont(distance(begin, pbegin))); - if (main_tag_opened) - closeTag(os, style); - os << '\n'; + closeTag(xs, style); + xs << html::CR(); } } // end anonymous namespace @@ -683,17 +1129,38 @@ void makeCommand(Buffer const & buf, void xhtmlParagraphs(Text const & text, Buffer const & buf, - odocstream & os, + XHTMLStream & xs, OutputParams const & runparams) { ParagraphList const & paragraphs = text.paragraphs(); - ParagraphList::const_iterator par = paragraphs.begin(); - ParagraphList::const_iterator pend = paragraphs.end(); + if (runparams.par_begin == runparams.par_end) { + runparams.par_begin = 0; + runparams.par_end = paragraphs.size(); + } + pit_type bpit = runparams.par_begin; + pit_type const epit = runparams.par_end; + LASSERT(bpit < epit, + { xs << XHTMLStream::ESCAPE_NONE << "\n"; return; }); OutputParams ourparams = runparams; - while (par != pend) { + ParagraphList::const_iterator const pend = + (epit == (int) paragraphs.size()) ? + paragraphs.end() : paragraphs.constIterator(epit); + while (bpit < epit) { + ParagraphList::const_iterator par = paragraphs.constIterator(bpit); + if (par->params().startOfAppendix()) { + // We want to reset the counter corresponding to toplevel sectioning + Layout const & lay = + buf.masterBuffer()->params().documentClass().getTOCLayout(); + docstring const cnt = lay.counter; + if (!cnt.empty()) { + Counters & cnts = + buf.masterBuffer()->params().documentClass().counters(); + cnts.reset(cnt); + } + } Layout const & style = par->layout(); - ParagraphList::const_iterator lastpar = par; + ParagraphList::const_iterator const lastpar = par; ParagraphList::const_iterator send; switch (style.latextype) { @@ -707,7 +1174,7 @@ void xhtmlParagraphs(Text const & text, // can communicate that back. // FIXME Maybe this fix should be in the routines themselves, in case // they are called from elsewhere. - makeCommand(buf, os, ourparams, text, par); + makeCommand(buf, xs, ourparams, text, par); ++par; break; } @@ -715,27 +1182,41 @@ void xhtmlParagraphs(Text const & text, case LATEX_LIST_ENVIRONMENT: case LATEX_ITEM_ENVIRONMENT: { // FIXME Same fix here. - send = searchEnvironmentHtml(par, pend); - par = makeEnvironmentHtml(buf, os, ourparams, text, par, send); + send = findEndOfEnvironment(par, pend); + par = makeEnvironment(buf, xs, ourparams, text, par, send); break; } case LATEX_BIB_ENVIRONMENT: { // FIXME Same fix here. - send = searchEnvironmentHtml(par, pend); - par = makeBibliography(buf, os, ourparams, text, par, send); + send = findEndOfEnvironment(par, pend); + par = makeBibliography(buf, xs, ourparams, text, par, send); break; } case LATEX_PARAGRAPH: - send = searchParagraphHtml(par, pend); - par = makeParagraphs(buf, os, ourparams, text, par, send); + send = findLastParagraph(par, pend); + par = makeParagraphs(buf, xs, ourparams, text, par, send); break; } - // FIXME?? - // makeEnvironment may process more than one paragraphs and bypass pend - if (distance(lastpar, par) >= distance(lastpar, pend)) - break; + bpit += distance(lastpar, par); } } +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