X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.cpp;h=dee3060e59131c45f1f46a1f53208ae15874ddab;hb=169bc143cb21810b18c8ec3253eaa9302e9ffdea;hp=27f36db5a05fbea14163b156dbeca398cd49386c;hpb=e6d1759340544112bd89a9c8b161a13cff96d63b;p=lyx.git diff --git a/src/output_xhtml.cpp b/src/output_xhtml.cpp index 27f36db5a0..dee3060e59 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 @@ -40,72 +43,78 @@ 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) +string escapeChar(char c, XHTMLStream::EscapeSettings e) { string 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 -string htmlize(string const & str) { +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); + d << escapeChar(*it, e); return d.str(); } @@ -126,27 +135,26 @@ docstring cleanAttr(docstring const & str) docstring newname; docstring::const_iterator it = str.begin(); docstring::const_iterator en = str.end(); - for (; it != en; ++it) - if (isalnum(*it)) - newname += *it; - else - newname += '_'; + 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? + // others? + return s == "em" || s == "strong" || s == "i" || s == "b"; } -} // namespace html docstring StartTag::asTag() const { string output = "<" + tag_; if (!attr_.empty()) - output += " " + html::htmlize(attr_); + output += " " + html::htmlize(attr_, XHTMLStream::ESCAPE_NONE); output += ">"; return from_utf8(output); } @@ -170,11 +178,14 @@ docstring CompTag::asTag() const { string output = "<" + tag_; if (!attr_.empty()) - output += " " + html::htmlize(attr_); + output += " " + html::htmlize(attr_, XHTMLStream::ESCAPE_NONE); output += " />"; return from_utf8(output); } +} // namespace html + + //////////////////////////////////////////////////////////////// /// @@ -183,17 +194,10 @@ docstring CompTag::asTag() const //////////////////////////////////////////////////////////////// XHTMLStream::XHTMLStream(odocstream & os) - : os_(os), nextraw_(false) + : os_(os), escape_(ESCAPE_ALL) {} -void XHTMLStream::cr() -{ - // tabs? - os_ << from_ascii("\n"); -} - - void XHTMLStream::writeError(std::string const & s) { LYXERR0(s); @@ -201,12 +205,18 @@ void XHTMLStream::writeError(std::string const & s) } +namespace { + // an illegal tag for internal use + static string const parsep_tag = "&LyX_parsep_tag&"; +} + + 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(); @@ -217,27 +227,87 @@ bool XHTMLStream::closeFontTags() return true; 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.tag_ == 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:"); + TagStack::const_reverse_iterator it = tag_stack_.rbegin(); + TagStack::const_reverse_iterator const en = tag_stack_.rend(); for (; it != en; ++it) { - if (html::isFontTag(it->tag_)) { - writeError("Font tag `" + it->tag_ + "' still open in closeFontTags()."); - noFontTags = false; + string const tagname = it->tag_; + if (tagname == parsep_tag) + break; + writeError(it->tag_); + } + return false; +} + + +void XHTMLStream::startParagraph(bool keep_empty) +{ + pending_tags_.push_back(html::StartTag(parsep_tag)); + if (keep_empty) + clearTagDeque(); +} + + +void XHTMLStream::endParagraph() +{ + if (!isTagOpen(parsep_tag)) { + // is it pending? + TagStack::const_iterator dit = pending_tags_.begin(); + TagStack::const_iterator const den = pending_tags_.end(); + bool found = false; + for (; dit != den; ++dit) { + if (dit->tag_ == parsep_tag) { + found = true; + break; + } } + + if (!found) { + writeError("No paragraph separation tag found in endParagraph()."); + return; + } + + // this case is normal. + 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 hasnt' been used. + html::StartTag const cur_tag = pending_tags_.back(); + string const & tag = cur_tag.tag_; + tag_stack_.pop_back(); + if (tag == parsep_tag) + break; + } + 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()) { + html::StartTag const cur_tag = tag_stack_.back(); + string const & tag = cur_tag.tag_; + tag_stack_.pop_back(); + if (tag == parsep_tag) + break; + writeError("Tag `" + tag + "' still open at end of paragraph. Closing."); + os_ << cur_tag.asEndTag(); } - return noFontTags; } void XHTMLStream::clearTagDeque() { while (!pending_tags_.empty()) { - StartTag const & tag = pending_tags_.front(); - // tabs? - os_ << tag.asTag(); + html::StartTag const & tag = pending_tags_.front(); + if (tag.tag_ != parsep_tag) + // tabs? + os_ << tag.asTag(); tag_stack_.push_back(tag); pending_tags_.pop_front(); } @@ -247,11 +317,8 @@ void XHTMLStream::clearTagDeque() XHTMLStream & XHTMLStream::operator<<(docstring const & d) { clearTagDeque(); - if (nextraw_) { - os_ << d; - nextraw_ = false; - } else - os_ << html::htmlize(d); + os_ << html::htmlize(d, escape_); + escape_ = ESCAPE_ALL; return *this; } @@ -260,11 +327,8 @@ XHTMLStream & XHTMLStream::operator<<(const char * s) { clearTagDeque(); docstring const d = from_ascii(s); - if (nextraw_) { - os_ << d; - nextraw_ = false; - } else - os_ << html::htmlize(d); + os_ << html::htmlize(d, escape_); + escape_ = ESCAPE_ALL; return *this; } @@ -272,23 +336,38 @@ XHTMLStream & XHTMLStream::operator<<(const char * s) XHTMLStream & XHTMLStream::operator<<(char_type c) { clearTagDeque(); - if (nextraw_) { - os_ << c; - nextraw_ = false; - } else - os_ << html::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<<(NextRaw const &) +XHTMLStream & XHTMLStream::operator<<(EscapeSettings e) { - nextraw_ = true; + escape_ = e; return *this; } -XHTMLStream & XHTMLStream::operator<<(StartTag const & tag) +XHTMLStream & XHTMLStream::operator<<(html::StartTag const & tag) { if (tag.tag_.empty()) return *this; @@ -299,13 +378,22 @@ 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(); + *this << html::CR(); + return *this; +} + + +XHTMLStream & XHTMLStream::operator<<(html::CR const &) +{ + // tabs? + os_ << from_ascii("\n"); return *this; } @@ -315,7 +403,6 @@ 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; @@ -327,13 +414,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_. @@ -344,13 +439,14 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) // 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(); + TagStack::iterator dit = pending_tags_.begin(); + TagStack::iterator const den = pending_tags_.end(); for (; dit != den; ++dit) { if (dit->tag_ == etag.tag_) { // it was pending, so we just erase it writeError("Tried to close pending tag `" + etag.tag_ - + "' when other tags were pending. Tag discarded."); + + "' when other tags were pending. Last pending tag is `" + + pending_tags_.back().tag_ + "'. Tag discarded."); pending_tags_.erase(dit); return *this; } @@ -415,7 +511,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_) { @@ -442,10 +538,11 @@ XHTMLStream & XHTMLStream::operator<<(EndTag const & etag) // at least guarantees proper nesting. writeError("Closing tag `" + etag.tag_ + "' when other tags are open, namely:"); - StartTag curtag = tag_stack_.back(); + html::StartTag curtag = tag_stack_.back(); while (curtag.tag_ != etag.tag_) { writeError(curtag.tag_); - os_ << curtag.asEndTag(); + if (curtag.tag_ != parsep_tag) + os_ << curtag.asEndTag(); tag_stack_.pop_back(); curtag = tag_stack_.back(); } @@ -464,37 +561,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 @@ -551,11 +676,11 @@ 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(); + 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. @@ -564,7 +689,7 @@ ParagraphList::const_iterator makeParagraphs(Buffer const & buf, bool const opened = runparams.html_make_pars && (par != pbegin || !runparams.html_in_par); if (opened) - openTag(xs, lay); + openTag(xs, lay, par->params()); docstring const deferred = par->simpleLyXHTMLOnePar(buf, xs, runparams, text.outerFont(distance(begin, par))); @@ -580,11 +705,10 @@ ParagraphList::const_iterator makeParagraphs(Buffer const & buf, || (!opened && runparams.html_in_par && par == pbegin && nextpar != pend); if (needclose) { closeTag(xs, lay); - xs.cr(); + xs << html::CR(); } if (!deferred.empty()) { - xs << XHTMLStream::NextRaw() << deferred; - xs.cr(); + xs << XHTMLStream::ESCAPE_NONE << deferred << html::CR(); } } return pend; @@ -598,14 +722,16 @@ ParagraphList::const_iterator makeBibliography(Buffer const & buf, ParagraphList::const_iterator const & pbegin, ParagraphList::const_iterator const & pend) { - xs << StartTag("h2", "class='bibliography'"); - xs << pbegin->layout().labelstring(false); - xs << EndTag("h2"); - xs.cr(); - xs << StartTag("div", "class='bibliography'"); - xs.cr(); + // 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 << EndTag("div"); + xs << html::EndTag("div"); return pend; } @@ -631,7 +757,7 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, // open tag for this environment openTag(xs, bstyle); - xs.cr(); + xs << html::CR(); // we will on occasion need to remember a layout from before. Layout const * lastlay = 0; @@ -650,7 +776,7 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, && (par == pbegin || !isNormalEnv(style)) && cnts.hasCounter(cntr) ) - cnts.step(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). @@ -669,46 +795,52 @@ 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 << html::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 << html::CR(); + } + else { + openLabelTag(xs, style); + xs << par->params().labelString(); + closeLabelTag(xs, style); + xs << html::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); - } + } // 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... && !isNormalEnv(style) @@ -719,7 +851,7 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, lastlay = &style; } else closeItemTag(xs, style); - xs.cr(); + xs << html::CR(); } // The other possibility is that the depth has increased, in which // case we need to recurse. @@ -749,7 +881,7 @@ ParagraphList::const_iterator makeEnvironmentHtml(Buffer const & buf, if (lastlay != 0) closeItemTag(xs, *lastlay); closeTag(xs, bstyle); - xs.cr(); + xs << html::CR(); return pend; } @@ -762,15 +894,15 @@ 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(" "); @@ -780,7 +912,7 @@ void makeCommand(Buffer const & buf, pbegin->simpleLyXHTMLOnePar(buf, xs, runparams, text.outerFont(distance(begin, pbegin))); closeTag(xs, style); - xs.cr(); + xs << html::CR(); } } // end anonymous namespace @@ -792,13 +924,29 @@ void xhtmlParagraphs(Text const & text, 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, /* */); 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()) { + // 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 const lastpar = par; ParagraphList::const_iterator send; switch (style.latextype) { @@ -835,12 +983,25 @@ void xhtmlParagraphs(Text const & text, 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