src/insets/InsetTOC.cpp

   1 /**
   2  * \file InsetTOC.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetTOC.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "BufferView.h"
  18 #include "Cursor.h"
  19 #include "DispatchResult.h"
  20 #include "Font.h"
  21 #include "FuncRequest.h"
  22 #include "Language.h"
  23 #include "LaTeXFeatures.h"
  24 #include "OutputParams.h"
  25 #include "output_xhtml.h"
  26 #include "Paragraph.h"
  27 #include "ParagraphParameters.h"
  28 #include "TextClass.h"
  29 #include "TocBackend.h"
  30
  31 #include "support/debug.h"
  32 #include "support/gettext.h"
  33 #include "support/lassert.h"
  34
  35 #include <ostream>
  36
  37 using namespace std;
  38
  39 namespace lyx {
  40
  41 namespace {
  42 string cmd2type(string const & cmd)
  43 {
  44         if (cmd == "lstlistoflistings")
  45                 return "listing";
  46         return cmd;
  47 }
  48 }
  49
  50
  51 InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p)
  52         : InsetCommand(buf, p)
  53 {}
  54
  55
  56 ParamInfo const & InsetTOC::findInfo(string const & /* cmdName */)
  57 {
  58         static ParamInfo param_info_;
  59         if (param_info_.empty()) {
  60                 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
  61         }
  62         return param_info_;
  63 }
  64
  65
  66 bool InsetTOC::isCompatibleCommand(string const & cmd)
  67 {
  68         return cmd == defaultCommand() || cmd == "lstlistoflistings";
  69 }
  70
  71
  72 docstring InsetTOC::screenLabel() const
  73 {
  74         if (getCmdName() == "tableofcontents")
  75                 return buffer().B_("Table of Contents");
  76         if (getCmdName() == "lstlistoflistings")
  77                 return buffer().B_("List of Listings");
  78         return _("Unknown TOC type");
  79 }
  80
  81
  82 void InsetTOC::doDispatch(Cursor & cur, FuncRequest & cmd) {
  83         switch (cmd.action()) {
  84         case LFUN_MOUSE_RELEASE:
  85                 if (!cur.selection() && cmd.button() == mouse_button::button1) {
  86                         cur.bv().showDialog("toc", params2string(params()));
  87                         cur.dispatched();
  88                 }
  89                 break;
  90
  91         default:
  92                 InsetCommand::doDispatch(cur, cmd);
  93         }
  94 }
  95
  96
  97 docstring InsetTOC::layoutName() const
  98 {
  99         if (getCmdName() == "lstlistoflistings")
 100                 return from_ascii("TOC:Listings");
 101         return from_ascii("TOC");
 102 }
 103
 104
 105 void InsetTOC::validate(LaTeXFeatures & features) const
 106 {
 107         InsetCommand::validate(features);
 108         features.useInsetLayout(getLayout());
 109         if (getCmdName() == "lstlistoflistings")
 110                 features.require("listings");
 111 }
 112
 113
 114 int InsetTOC::plaintext(odocstringstream & os,
 115         OutputParams const &, size_t max_length) const
 116 {
 117         os << screenLabel() << "\n\n";
 118         buffer().tocBackend().writePlaintextTocList(cmd2type(getCmdName()), os, max_length);
 119         return PLAINTEXT_NEWLINE;
 120 }
 121
 122
 123 int InsetTOC::docbook(odocstream & os, OutputParams const &) const
 124 {
 125         if (getCmdName() == "tableofcontents")
 126                 os << "<toc></toc>";
 127         return 0;
 128 }
 129
 130
 131 void InsetTOC::makeTOCEntry(XHTMLStream & xs,
 132                 Paragraph const & par, OutputParams const & op) const
 133 {
 134         string const attr = "href='#" + par.magicLabel() + "' class='tocentry'";
 135         xs << html::StartTag("a", attr);
 136
 137         // First the label, if there is one
 138         docstring const & label = par.params().labelString();
 139         if (!label.empty())
 140                 xs << label << " ";
 141         // Now the content of the TOC entry, taken from the paragraph itself
 142         OutputParams ours = op;
 143         ours.for_toc = true;
 144         Font const dummy;
 145         par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy);
 146
 147         xs << html::EndTag("a") << html::CR();
 148 }
 149
 150
 151 void InsetTOC::makeTOCWithDepth(XHTMLStream & xs,
 152                 Toc const & toc, OutputParams const & op) const
 153 {
 154         Toc::const_iterator it = toc.begin();
 155         Toc::const_iterator const en = toc.end();
 156         int lastdepth = 0;
 157         for (; it != en; ++it) {
 158                 // do not output entries that are not actually included in the output,
 159                 // e.g., stuff in non-active branches or notes or whatever.
 160                 if (!it->isOutput())
 161                         continue;
 162
 163                 // First, we need to manage increases and decreases of depth
 164                 // If there's no depth to deal with, we artifically set it to 1.
 165                 int const depth = it->depth();
 166
 167                 // Ignore stuff above the tocdepth
 168                 if (depth > buffer().params().tocdepth)
 169                         continue;
 170
 171                 if (depth > lastdepth) {
 172                         xs << html::CR();
 173                         // open as many tags as we need to open to get to this level
 174                         // this includes the tag for the current level
 175                         for (int i = lastdepth + 1; i <= depth; ++i) {
 176                                 stringstream attr;
 177                                 attr << "class='lyxtoc-" << i << "'";
 178                                 xs << html::StartTag("div", attr.str()) << html::CR();
 179                         }
 180                         lastdepth = depth;
 181                 }
 182                 else if (depth < lastdepth) {
 183                         // close as many as we have to close to get back to this level
 184                         // this includes closing the last tag at this level
 185                         for (int i = lastdepth; i >= depth; --i)
 186                                 xs << html::EndTag("div") << html::CR();
 187                         // now open our tag
 188                         stringstream attr;
 189                         attr << "class='lyxtoc-" << depth << "'";
 190                         xs << html::StartTag("div", attr.str()) << html::CR();
 191                         lastdepth = depth;
 192                 } else {
 193                         // no change of level, so close and open
 194                         xs << html::EndTag("div") << html::CR();
 195                         stringstream attr;
 196                         attr << "class='lyxtoc-" << depth << "'";
 197                         xs << html::StartTag("div", attr.str()) << html::CR();
 198                 }
 199
 200                 // Now output TOC info for this entry
 201                 Paragraph const & par = it->dit().innerParagraph();
 202                 makeTOCEntry(xs, par, op);
 203         }
 204         for (int i = lastdepth; i > 0; --i)
 205                 xs << html::EndTag("div") << html::CR();
 206 }
 207
 208
 209 void InsetTOC::makeTOCNoDepth(XHTMLStream & xs,
 210                 Toc const & toc, const OutputParams & op) const
 211 {
 212         Toc::const_iterator it = toc.begin();
 213         Toc::const_iterator const en = toc.end();
 214         for (; it != en; ++it) {
 215                 // do not output entries that are not actually included in the output,
 216                 // e.g., stuff in non-active branches or notes or whatever.
 217                 if (!it->isOutput())
 218                         continue;
 219
 220                 xs << html::StartTag("div", "class='lyxtoc-flat'") << html::CR();
 221
 222                 Paragraph const & par = it->dit().innerParagraph();
 223                 makeTOCEntry(xs, par, op);
 224
 225                 xs << html::EndTag("div");
 226         }
 227 }
 228
 229
 230 docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const
 231 {
 232         string const & command = getCmdName();
 233         if (command != "tableofcontents" && command != "lstlistoflistings") {
 234                 LYXERR0("TOC type " << command << " not yet implemented.");
 235                 LASSERT(false, return docstring());
 236         }
 237
 238         shared_ptr<Toc const> toc =
 239                 buffer().masterBuffer()->tocBackend().toc(cmd2type(command));
 240         if (toc->empty())
 241                 return docstring();
 242
 243         // we'll use our own stream, because we are going to defer everything.
 244         // that's how we deal with the fact that we're probably inside a standard
 245         // paragraph, and we don't want to be.
 246         odocstringstream ods;
 247         XHTMLStream xs(ods);
 248
 249         xs << html::StartTag("div", "class='toc'");
 250
 251         // Title of TOC
 252         InsetLayout const & il = getLayout();
 253         string const & tag = il.htmltag();
 254         docstring title = screenLabel();
 255         Layout const & lay = buffer().params().documentClass().htmlTOCLayout();
 256         string const & tocclass = lay.defaultCSSClass();
 257         string const tocattr = "class='tochead " + tocclass + "'";
 258         xs << html::StartTag(tag, tocattr)
 259                  << title
 260                  << html::EndTag(tag);
 261
 262         // with lists of listings, at least, there is no depth
 263         // to worry about. so the code can be simpler.
 264         bool const use_depth = (command == "tableofcontents");
 265
 266         // Output of TOC
 267         if (use_depth)
 268                 makeTOCWithDepth(xs, *toc, op);
 269         else
 270                 makeTOCNoDepth(xs, *toc, op);
 271
 272         xs << html::EndTag("div") << html::CR();
 273         return ods.str();
 274 }
 275
 276
 277 } // namespace lyx