]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetTOC.cpp
Minor corrections and elaborations
[lyx.git] / src / insets / InsetTOC.cpp
index 08d77bb32868d3310f0837eca54cea6d33fa6b9a..0308392c0d3abaad4e474602032b4278c30d3447 100644 (file)
@@ -21,7 +21,6 @@
 #include "FuncRequest.h"
 #include "Language.h"
 #include "LaTeXFeatures.h"
-#include "OutputParams.h"
 #include "output_xhtml.h"
 #include "Paragraph.h"
 #include "ParagraphParameters.h"
@@ -29,7 +28,9 @@
 #include "TocBackend.h"
 
 #include "support/debug.h"
+#include "support/docstream.h"
 #include "support/gettext.h"
+#include "support/lassert.h"
 
 #include <ostream>
 
@@ -44,7 +45,7 @@ string cmd2type(string const & cmd)
                return "listing";
        return cmd;
 }
-}
+} // namespace
 
 
 InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p)
@@ -86,7 +87,7 @@ void InsetTOC::doDispatch(Cursor & cur, FuncRequest & cmd) {
                        cur.dispatched();
                }
                break;
-       
+
        default:
                InsetCommand::doDispatch(cur, cmd);
        }
@@ -95,9 +96,13 @@ void InsetTOC::doDispatch(Cursor & cur, FuncRequest & cmd) {
 
 docstring InsetTOC::layoutName() const
 {
-       if (getCmdName() == "lstlistoflistings")
-               return from_ascii("TOC:Listings");
-       return docstring();
+       if (getCmdName() == "lstlistoflistings") {
+               if (buffer().params().use_minted)
+                       return from_ascii("TOC:MintedListings");
+               else
+                       return from_ascii("TOC:Listings");
+       }
+       return from_ascii("TOC");
 }
 
 
@@ -105,8 +110,12 @@ void InsetTOC::validate(LaTeXFeatures & features) const
 {
        InsetCommand::validate(features);
        features.useInsetLayout(getLayout());
-       if (getCmdName() == "lstlistoflistings")
-               features.require("listings");
+       if (getCmdName() == "lstlistoflistings") {
+               if (buffer().params().use_minted)
+                       features.require("minted");
+               else
+                       features.require("listings");
+       }
 }
 
 
@@ -119,117 +128,157 @@ int InsetTOC::plaintext(odocstringstream & os,
 }
 
 
-int InsetTOC::docbook(odocstream & os, OutputParams const &) const
+void InsetTOC::docbook(XMLStream &, OutputParams const &) const
 {
-       if (getCmdName() == "tableofcontents")
-               os << "<toc></toc>";
-       return 0;
+       // TOC are generated automatically by the DocBook processor.
+       return;
 }
 
 
-docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const
+void InsetTOC::makeTOCEntry(XMLStream & xs,
+               Paragraph const & par, OutputParams const & op) const
 {
-       if (getCmdName() != "tableofcontents")
-               return docstring();
-
-       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);
-
-       Toc const & toc = buffer().tocBackend().toc(cmd2type(getCmdName()));
-       if (toc.empty())
-               return docstring();
+       string const attr = "href='#" + par.magicLabel() + "' class='tocentry'";
+       xs << xml::StartTag("a", attr);
+
+       // 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 << xml::EndTag("a") << xml::CR();
+}
 
-       xs << html::StartTag("div", "class='toc'");
 
-       // Title of TOC
-       docstring title = screenLabel();
-       xs << html::StartTag("div", tocattr)
-                << title
-                << html::EndTag("div");
-
-       // Output of TOC
-       Toc::const_iterator it = toc.begin();
-       Toc::const_iterator const en = toc.end();
+void InsetTOC::makeTOCWithDepth(XMLStream & xs,
+               Toc const & toc, OutputParams const & op) const
+{
        int lastdepth = 0;
-       for (; it != en; ++it) {
+       for (auto const & tocitem : toc) {
                // 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())
+               if (!tocitem.isOutput())
+                       continue;
+
+               if (!tocitem.dit().paragraph().layout().htmlintoc())
                        continue;
 
                // First, we need to manage increases and decreases of depth
-               int const depth = it->depth();
-               
+               // If there's no depth to deal with, we artificially set it to 1.
+               int const depth = tocitem.depth();
+
                // Ignore stuff above the tocdepth
                if (depth > buffer().params().tocdepth)
                        continue;
-               
+
                if (depth > lastdepth) {
-                       xs << html::CR();
+                       xs << xml::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()) << html::CR();
+                               xs << xml::StartTag("div", attr.str()) << xml::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") << html::CR();
+                       for (int i = lastdepth; i >= depth; --i)
+                               xs << xml::EndTag("div") << xml::CR();
                        // now open our tag
                        stringstream attr;
                        attr << "class='lyxtoc-" << depth << "'";
-                       xs << html::StartTag("div", attr.str()) << html::CR();
+                       xs << xml::StartTag("div", attr.str()) << xml::CR();
                        lastdepth = depth;
                } else {
                        // no change of level, so close and open
-                       xs << html::EndTag("div") << html::CR();
+                       xs << xml::EndTag("div") << xml::CR();
                        stringstream attr;
                        attr << "class='lyxtoc-" << depth << "'";
-                       xs << html::StartTag("div", attr.str()) << html::CR();
+                       xs << xml::StartTag("div", attr.str()) << xml::CR();
                }
-               
+
                // Now output TOC info for this entry
-               Paragraph const & par = it->dit().innerParagraph();
-
-               string const attr = "href='#" + par.magicLabel() + "' class='tocentry'";
-               xs << html::StartTag("a", attr);
-
-               // 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::EndTag("a") << " ";
-
-               // 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::ESCAPE_NONE << "&gt;";
-               xs << html::EndTag("a");                
+               Paragraph const & par = tocitem.dit().innerParagraph();
+               makeTOCEntry(xs, par, op);
        }
-       for (int i = lastdepth; i > 0; --i) 
-               xs << html::EndTag("div") << html::CR();
-       xs << html::EndTag("div") << html::CR();
+       for (int i = lastdepth; i > 0; --i)
+               xs << xml::EndTag("div") << xml::CR();
+}
+
+
+void InsetTOC::makeTOCNoDepth(XMLStream & xs,
+               Toc const & toc, const OutputParams & op) const
+{
+       for (auto const & tocitem : toc) {
+               // do not output entries that are not actually included in the output,
+               // e.g., stuff in non-active branches or notes or whatever.
+               if (!tocitem.isOutput())
+                       continue;
+
+               if (!tocitem.dit().paragraph().layout().htmlintoc())
+                       continue;
+
+               xs << xml::StartTag("div", "class='lyxtoc-flat'") << xml::CR();
+
+               Paragraph const & par = tocitem.dit().innerParagraph();
+               makeTOCEntry(xs, par, op);
+
+               xs << xml::EndTag("div");
+       }
+}
+
+
+docstring InsetTOC::xhtml(XMLStream &, 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 const> 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;
+       XMLStream xs(ods);
+
+       xs << xml::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 << xml::StartTag(tag, tocattr)
+                << title
+                << xml::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 << xml::EndTag("div") << xml::CR();
        return ods.str();
 }