X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetTOC.cpp;h=29b7540cc277cbb2c690e5f15a2a2e50e4b49b12;hb=2777b51c587cb061b3214c670a3cc4b357528e6c;hp=8c423f2f43476a11e530e2c93a2a4a4224d1ae19;hpb=7cd56e334d434e90b248aa75dfc6a002be7065b0;p=lyx.git diff --git a/src/insets/InsetTOC.cpp b/src/insets/InsetTOC.cpp index 8c423f2f43..29b7540cc2 100644 --- a/src/insets/InsetTOC.cpp +++ b/src/insets/InsetTOC.cpp @@ -14,11 +14,13 @@ #include "Buffer.h" #include "BufferParams.h" +#include "BufferView.h" +#include "Cursor.h" #include "DispatchResult.h" +#include "Font.h" #include "FuncRequest.h" #include "Language.h" #include "LaTeXFeatures.h" -#include "MetricsInfo.h" #include "OutputParams.h" #include "output_xhtml.h" #include "Paragraph.h" @@ -28,6 +30,7 @@ #include "support/debug.h" #include "support/gettext.h" +#include "support/lassert.h" #include @@ -35,9 +38,18 @@ using namespace std; namespace lyx { +namespace { +string cmd2type(string const & cmd) +{ + if (cmd == "lstlistoflistings") + return "listing"; + return cmd; +} +} // namespace + InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p) - : InsetCommand(buf, p, "toc") + : InsetCommand(buf, p) {} @@ -51,18 +63,67 @@ ParamInfo const & InsetTOC::findInfo(string const & /* cmdName */) } +bool InsetTOC::isCompatibleCommand(string const & cmd) +{ + return cmd == defaultCommand() || cmd == "lstlistoflistings"; +} + + docstring InsetTOC::screenLabel() const { if (getCmdName() == "tableofcontents") return buffer().B_("Table of Contents"); + if (getCmdName() == "lstlistoflistings") + return buffer().B_("List of Listings"); return _("Unknown TOC type"); } -int InsetTOC::plaintext(odocstream & os, OutputParams const &) const +void InsetTOC::doDispatch(Cursor & cur, FuncRequest & cmd) { + switch (cmd.action()) { + case LFUN_MOUSE_RELEASE: + if (!cur.selection() && cmd.button() == mouse_button::button1) { + cur.bv().showDialog("toc", params2string(params())); + cur.dispatched(); + } + break; + + default: + InsetCommand::doDispatch(cur, cmd); + } +} + + +docstring InsetTOC::layoutName() const +{ + if (getCmdName() == "lstlistoflistings") { + if (buffer().params().use_minted) + return from_ascii("TOC:MintedListings"); + else + return from_ascii("TOC:Listings"); + } + return from_ascii("TOC"); +} + + +void InsetTOC::validate(LaTeXFeatures & features) const +{ + InsetCommand::validate(features); + features.useInsetLayout(getLayout()); + if (getCmdName() == "lstlistoflistings") { + if (buffer().params().use_minted) + features.require("minted"); + else + features.require("listings"); + } +} + + +int InsetTOC::plaintext(odocstringstream & os, + OutputParams const &, size_t max_length) const { os << screenLabel() << "\n\n"; - buffer().tocBackend().writePlaintextTocList(getCmdName(), os); + buffer().tocBackend().writePlaintextTocList(cmd2type(getCmdName()), os, max_length); return PLAINTEXT_NEWLINE; } @@ -75,99 +136,148 @@ int InsetTOC::docbook(odocstream & os, OutputParams const &) const } -docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const +void InsetTOC::makeTOCEntry(XHTMLStream & xs, + Paragraph const & par, OutputParams const & op) const { - Layout const & lay = buffer().params().documentClass().htmlTOCLayout(); - string const & tocclass = lay.defaultCSSClass(); - string const tocattr = "class='tochead " + tocclass + "'"; - - // we'll use our own stream, because we are going to defer everything. - // that's how we deal with the fact that we're probably inside a standard - // paragraph, and we don't want to be. - odocstringstream ods; - XHTMLStream xs(ods); + string const attr = "href='#" + par.magicLabel() + "' class='tocentry'"; + xs << html::StartTag("a", attr); - Toc const & toc = buffer().tocBackend().toc("tableofcontents"); - if (toc.empty()) - return docstring(); + // First the label, if there is one + docstring const & label = par.params().labelString(); + if (!label.empty()) + xs << label << " "; + // Now the content of the TOC entry, taken from the paragraph itself + OutputParams ours = op; + ours.for_toc = true; + Font const dummy; + par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy); - xs << html::StartTag("div", "class='toc'"); + xs << html::EndTag("a") << html::CR(); +} - // Title of TOC - Language const * lang = buffer().params().language; - static string toctitle = N_("Table of Contents"); - docstring title = lang - ? translateIfPossible(from_ascii(toctitle), lang->code()) - : translateIfPossible(from_ascii(toctitle)); - xs << html::StartTag("div", tocattr) - << title - << html::EndTag("div"); - // Output of TOC +void InsetTOC::makeTOCWithDepth(XHTMLStream & xs, + Toc const & toc, OutputParams const & op) const +{ Toc::const_iterator it = toc.begin(); Toc::const_iterator const en = toc.end(); int lastdepth = 0; for (; it != en; ++it) { + // do not output entries that are not actually included in the output, + // e.g., stuff in non-active branches or notes or whatever. + if (!it->isOutput()) + continue; + // First, we need to manage increases and decreases of depth + // If there's no depth to deal with, we artifically set it to 1. int const depth = it->depth(); - + // Ignore stuff above the tocdepth if (depth > buffer().params().tocdepth) continue; - + if (depth > lastdepth) { - xs.cr(); + xs << html::CR(); // open as many tags as we need to open to get to this level // this includes the tag for the current level for (int i = lastdepth + 1; i <= depth; ++i) { stringstream attr; attr << "class='lyxtoc-" << i << "'"; - xs << html::StartTag("div", attr.str()); + xs << html::StartTag("div", attr.str()) << html::CR(); } lastdepth = depth; } else if (depth < lastdepth) { // close as many as we have to close to get back to this level // this includes closing the last tag at this level - for (int i = lastdepth; i >= depth; --i) - xs << html::EndTag("div"); + for (int i = lastdepth; i >= depth; --i) + xs << html::EndTag("div") << html::CR(); // now open our tag stringstream attr; attr << "class='lyxtoc-" << depth << "'"; - xs << html::StartTag("div", attr.str()); + xs << html::StartTag("div", attr.str()) << html::CR(); lastdepth = depth; } else { // no change of level, so close and open - xs << html::EndTag("div"); + xs << html::EndTag("div") << html::CR(); stringstream attr; attr << "class='lyxtoc-" << depth << "'"; - xs << html::StartTag("div", attr.str()); + xs << html::StartTag("div", attr.str()) << html::CR(); } - + // Now output TOC info for this entry Paragraph const & par = it->dit().innerParagraph(); - // First the label, if there is one - docstring const & label = par.params().labelString(); - if (!label.empty()) - xs << label << " "; - // Now the content of the TOC entry, taken from the paragraph itself - OutputParams ours = op; - ours.for_toc = true; - Font const dummy; - par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy); - xs << " "; - // Now a link to that paragraph - string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'"; - xs << html::StartTag("a", parattr); - // FIXME XHTML - // There ought to be a simple way to customize this. - // Maybe if we had an InsetLayout for TOC... - xs << XHTMLStream::NextRaw() << "⇘"; - xs << html::EndTag("a"); + makeTOCEntry(xs, par, op); } - for (int i = lastdepth; i > 0; --i) + for (int i = lastdepth; i > 0; --i) + xs << html::EndTag("div") << html::CR(); +} + + +void InsetTOC::makeTOCNoDepth(XHTMLStream & xs, + Toc const & toc, const OutputParams & op) const +{ + Toc::const_iterator it = toc.begin(); + Toc::const_iterator const en = toc.end(); + for (; it != en; ++it) { + // do not output entries that are not actually included in the output, + // e.g., stuff in non-active branches or notes or whatever. + if (!it->isOutput()) + continue; + + xs << html::StartTag("div", "class='lyxtoc-flat'") << html::CR(); + + Paragraph const & par = it->dit().innerParagraph(); + makeTOCEntry(xs, par, op); + xs << html::EndTag("div"); - xs << html::EndTag("div"); + } +} + + +docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const +{ + string const & command = getCmdName(); + if (command != "tableofcontents" && command != "lstlistoflistings") { + LYXERR0("TOC type " << command << " not yet implemented."); + LASSERT(false, return docstring()); + } + + shared_ptr toc = + buffer().masterBuffer()->tocBackend().toc(cmd2type(command)); + if (toc->empty()) + return docstring(); + + // we'll use our own stream, because we are going to defer everything. + // that's how we deal with the fact that we're probably inside a standard + // paragraph, and we don't want to be. + odocstringstream ods; + XHTMLStream xs(ods); + + xs << html::StartTag("div", "class='toc'"); + + // Title of TOC + InsetLayout const & il = getLayout(); + string const & tag = il.htmltag(); + docstring title = screenLabel(); + Layout const & lay = buffer().params().documentClass().htmlTOCLayout(); + string const & tocclass = lay.defaultCSSClass(); + string const tocattr = "class='tochead " + tocclass + "'"; + xs << html::StartTag(tag, tocattr) + << title + << html::EndTag(tag); + + // with lists of listings, at least, there is no depth + // to worry about. so the code can be simpler. + bool const use_depth = (command == "tableofcontents"); + + // Output of TOC + if (use_depth) + makeTOCWithDepth(xs, *toc, op); + else + makeTOCNoDepth(xs, *toc, op); + + xs << html::EndTag("div") << html::CR(); return ods.str(); }