]> git.lyx.org Git - lyx.git/blob - src/insets/InsetTOC.cpp
tex2lyx/text.cpp: fix typos
[lyx.git] / 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
34 #include <ostream>
35
36 using namespace std;
37
38 namespace lyx {
39
40 namespace {
41 string cmd2type(string const & cmd)
42 {
43         if (cmd == "lstlistoflistings")
44                 return "listing";
45         return cmd;
46 }
47 }
48
49
50 InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p)
51         : InsetCommand(buf, p)
52 {}
53
54
55 ParamInfo const & InsetTOC::findInfo(string const & /* cmdName */)
56 {
57         static ParamInfo param_info_;
58         if (param_info_.empty()) {
59                 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
60         }
61         return param_info_;
62 }
63
64
65 bool InsetTOC::isCompatibleCommand(string const & cmd)
66 {
67         return cmd == defaultCommand() || cmd == "lstlistoflistings";
68 }
69
70
71 docstring InsetTOC::screenLabel() const
72 {
73         if (getCmdName() == "tableofcontents")
74                 return buffer().B_("Table of Contents");
75         if (getCmdName() == "lstlistoflistings")
76                 return buffer().B_("List of Listings");
77         return _("Unknown TOC type");
78 }
79
80
81 void InsetTOC::doDispatch(Cursor & cur, FuncRequest & cmd) {
82         switch (cmd.action()) {
83         case LFUN_MOUSE_RELEASE:
84                 if (!cur.selection() && cmd.button() == mouse_button::button1) {
85                         cur.bv().showDialog("toc", params2string(params()));
86                         cur.dispatched();
87                 }
88                 break;
89         
90         default:
91                 InsetCommand::doDispatch(cur, cmd);
92         }
93 }
94
95
96 docstring InsetTOC::layoutName() const
97 {
98         if (getCmdName() == "lstlistoflistings")
99                 return from_ascii("TOC:Listings");
100         return docstring();
101 }
102
103
104 void InsetTOC::validate(LaTeXFeatures & features) const
105 {
106         InsetCommand::validate(features);
107         features.useInsetLayout(getLayout());
108         if (getCmdName() == "lstlistoflistings")
109                 features.require("listings");
110 }
111
112
113 int InsetTOC::plaintext(odocstream & os, OutputParams const &) const
114 {
115         os << screenLabel() << "\n\n";
116         buffer().tocBackend().writePlaintextTocList(cmd2type(getCmdName()), os);
117         return PLAINTEXT_NEWLINE;
118 }
119
120
121 int InsetTOC::docbook(odocstream & os, OutputParams const &) const
122 {
123         if (getCmdName() == "tableofcontents")
124                 os << "<toc></toc>";
125         return 0;
126 }
127
128
129 docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const
130 {
131         if (getCmdName() != "tableofcontents")
132                 return docstring();
133
134         Layout const & lay = buffer().params().documentClass().htmlTOCLayout();
135         string const & tocclass = lay.defaultCSSClass();
136         string const tocattr = "class='tochead " + tocclass + "'";
137         
138         // we'll use our own stream, because we are going to defer everything.
139         // that's how we deal with the fact that we're probably inside a standard
140         // paragraph, and we don't want to be.
141         odocstringstream ods;
142         XHTMLStream xs(ods);
143
144         Toc const & toc = buffer().tocBackend().toc(cmd2type(getCmdName()));
145         if (toc.empty())
146                 return docstring();
147
148         xs << html::StartTag("div", "class='toc'");
149
150         // Title of TOC
151         docstring title = screenLabel();
152         xs << html::StartTag("div", tocattr)
153                  << title
154                  << html::EndTag("div");
155
156         // Output of TOC
157         Toc::const_iterator it = toc.begin();
158         Toc::const_iterator const en = toc.end();
159         int lastdepth = 0;
160         for (; it != en; ++it) {
161                 // First, we need to manage increases and decreases of depth
162                 int const depth = it->depth();
163                 
164                 // Ignore stuff above the tocdepth
165                 if (depth > buffer().params().tocdepth)
166                         continue;
167                 
168                 if (depth > lastdepth) {
169                         xs << html::CR();
170                         // open as many tags as we need to open to get to this level
171                         // this includes the tag for the current level
172                         for (int i = lastdepth + 1; i <= depth; ++i) {
173                                 stringstream attr;
174                                 attr << "class='lyxtoc-" << i << "'";
175                                 xs << html::StartTag("div", attr.str()) << html::CR();
176                         }
177                         lastdepth = depth;
178                 }
179                 else if (depth < lastdepth) {
180                         // close as many as we have to close to get back to this level
181                         // this includes closing the last tag at this level
182                         for (int i = lastdepth; i >= depth; --i) 
183                                 xs << html::EndTag("div") << html::CR();
184                         // now open our tag
185                         stringstream attr;
186                         attr << "class='lyxtoc-" << depth << "'";
187                         xs << html::StartTag("div", attr.str()) << html::CR();
188                         lastdepth = depth;
189                 } else {
190                         // no change of level, so close and open
191                         xs << html::EndTag("div") << html::CR();
192                         stringstream attr;
193                         attr << "class='lyxtoc-" << depth << "'";
194                         xs << html::StartTag("div", attr.str()) << html::CR();
195                 }
196                 
197                 // Now output TOC info for this entry
198                 Paragraph const & par = it->dit().innerParagraph();
199
200                 string const attr = "href='#" + par.magicLabel() + "' class='tocentry'";
201                 xs << html::StartTag("a", attr);
202
203                 // First the label, if there is one
204                 docstring const & label = par.params().labelString();
205                 if (!label.empty())
206                         xs << label << " ";
207                 // Now the content of the TOC entry, taken from the paragraph itself
208                 OutputParams ours = op;
209                 ours.for_toc = true;
210                 Font const dummy;
211                 par.simpleLyXHTMLOnePar(buffer(), xs, ours, dummy);
212
213                 xs << html::EndTag("a") << " ";
214
215                 // Now a link to that paragraph
216                 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
217                 xs << html::StartTag("a", parattr);
218                 // FIXME XHTML 
219                 // There ought to be a simple way to customize this.
220                 // Maybe if we had an InsetLayout for TOC...
221                 xs << XHTMLStream::ESCAPE_NONE << "&gt;";
222                 xs << html::EndTag("a");                
223         }
224         for (int i = lastdepth; i > 0; --i) 
225                 xs << html::EndTag("div") << html::CR();
226         xs << html::EndTag("div") << html::CR();
227         return ods.str();
228 }
229
230
231 } // namespace lyx