3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
16 #include "BufferParams.h"
17 #include "BufferView.h"
19 #include "DispatchResult.h"
21 #include "FuncRequest.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"
31 #include "support/debug.h"
32 #include "support/gettext.h"
33 #include "support/lassert.h"
42 string cmd2type(string const & cmd)
44 if (cmd == "lstlistoflistings")
51 InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p)
52 : InsetCommand(buf, p)
56 ParamInfo const & InsetTOC::findInfo(string const & /* cmdName */)
58 static ParamInfo param_info_;
59 if (param_info_.empty()) {
60 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
66 bool InsetTOC::isCompatibleCommand(string const & cmd)
68 return cmd == defaultCommand() || cmd == "lstlistoflistings";
72 docstring InsetTOC::screenLabel() const
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");
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()));
92 InsetCommand::doDispatch(cur, cmd);
97 docstring InsetTOC::layoutName() const
99 if (getCmdName() == "lstlistoflistings")
100 return from_ascii("TOC:Listings");
101 return from_ascii("TOC");
105 void InsetTOC::validate(LaTeXFeatures & features) const
107 InsetCommand::validate(features);
108 features.useInsetLayout(getLayout());
109 if (getCmdName() == "lstlistoflistings")
110 features.require("listings");
114 int InsetTOC::plaintext(odocstringstream & os,
115 OutputParams const &, size_t max_length) const
117 os << screenLabel() << "\n\n";
118 buffer().tocBackend().writePlaintextTocList(cmd2type(getCmdName()), os, max_length);
119 return PLAINTEXT_NEWLINE;
123 int InsetTOC::docbook(odocstream & os, OutputParams const &) const
125 if (getCmdName() == "tableofcontents")
131 void InsetTOC::makeTOCWithDepth(XHTMLStream xs,
132 Toc toc, OutputParams const & op) const
134 Toc::const_iterator it = toc.begin();
135 Toc::const_iterator const en = toc.end();
137 for (; it != en; ++it) {
138 // do not output entries that are not actually included in the output,
139 // e.g., stuff in non-active branches or notes or whatever.
143 // First, we need to manage increases and decreases of depth
144 // If there's no depth to deal with, we artifically set it to 1.
145 int const depth = it->depth();
147 // Ignore stuff above the tocdepth
148 if (depth > buffer().params().tocdepth)
151 if (depth > lastdepth) {
153 // open as many tags as we need to open to get to this level
154 // this includes the tag for the current level
155 for (int i = lastdepth + 1; i <= depth; ++i) {
157 attr << "class='lyxtoc-" << i << "'";
158 xs << html::StartTag("div", attr.str()) << html::CR();
162 else if (depth < lastdepth) {
163 // close as many as we have to close to get back to this level
164 // this includes closing the last tag at this level
165 for (int i = lastdepth; i >= depth; --i)
166 xs << html::EndTag("div") << html::CR();
169 attr << "class='lyxtoc-" << depth << "'";
170 xs << html::StartTag("div", attr.str()) << html::CR();
173 // no change of level, so close and open
174 xs << html::EndTag("div") << html::CR();
176 attr << "class='lyxtoc-" << depth << "'";
177 xs << html::StartTag("div", attr.str()) << html::CR();
180 // Now output TOC info for this entry
181 Paragraph const & par = it->dit().innerParagraph();
183 string const attr = "href='#" + par.magicLabel() + "' class='tocentry'";
184 xs << html::StartTag("a", attr);
186 // First the label, if there is one
187 docstring const & label = par.params().labelString();
190 // Now the content of the TOC entry, taken from the paragraph itself
191 OutputParams ours = op;
194 par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy);
196 xs << html::EndTag("a") << " ";
198 // Now a link to that paragraph
199 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
200 xs << html::StartTag("a", parattr);
202 // There ought to be a simple way to customize this.
203 // Maybe if we had an InsetLayout for TOC...
204 xs << XHTMLStream::ESCAPE_NONE << ">";
205 xs << html::EndTag("a");
207 for (int i = lastdepth; i > 0; --i)
208 xs << html::EndTag("div") << html::CR();
212 void InsetTOC::makeTOCNoDepth(XHTMLStream xs,
213 Toc toc, const OutputParams & op) const
215 Toc::const_iterator it = toc.begin();
216 Toc::const_iterator const en = toc.end();
217 for (; it != en; ++it) {
218 // do not output entries that are not actually included in the output,
219 // e.g., stuff in non-active branches or notes or whatever.
223 xs << html::StartTag("div", "class='lyxtop-1'") << html::CR();
225 Paragraph const & par = it->dit().innerParagraph();
226 string const attr = "href='#" + par.magicLabel() + "' class='tocentry'";
227 xs << html::StartTag("a", attr);
229 // First the label, if there is one
230 docstring const & label = par.params().labelString();
233 // Now the content of the TOC entry, taken from the paragraph itself
234 OutputParams ours = op;
237 par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy);
239 xs << html::EndTag("a") << " ";
241 // Now a link to that paragraph
242 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
243 xs << html::StartTag("a", parattr);
245 // There ought to be a simple way to customize this.
246 // Maybe if we had an InsetLayout for TOC...
247 xs << XHTMLStream::ESCAPE_NONE << ">";
248 xs << html::EndTag("a");
249 xs << html::EndTag("div");
254 docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const
256 string const & command = getCmdName();
257 if (command != "tableofcontents" && command != "lstlistoflistings") {
258 LYXERR0("TOC type " << command << " not yet implemented.");
259 LASSERT(false, /* */);
263 // with lists of listings, at least, there is no depth
264 // to worry about. so the code can be simpler.
265 bool const use_depth = (command == "tableofcontents");
267 Layout const & lay = buffer().params().documentClass().htmlTOCLayout();
268 string const & tocclass = lay.defaultCSSClass();
269 string const tocattr = "class='tochead " + tocclass + "'";
271 // we'll use our own stream, because we are going to defer everything.
272 // that's how we deal with the fact that we're probably inside a standard
273 // paragraph, and we don't want to be.
274 odocstringstream ods;
277 Toc const & toc = buffer().tocBackend().toc(cmd2type(command));
281 xs << html::StartTag("div", "class='toc'");
284 docstring title = screenLabel();
285 xs << html::StartTag("div", tocattr)
287 << html::EndTag("div");
291 makeTOCWithDepth(xs, toc, op);
293 makeTOCNoDepth(xs, toc, op);
295 xs << html::EndTag("div") << html::CR();