1 /**
2 * \file InsetFoot.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
5 *
6 * \author Jürgen Vigna
7 * \author Lars Gullik Bjønnes
8 *
9 * Full author contact details are available in file CREDITS.
10 */
11
12 #include <config.h>
13
14 #include "InsetFoot.h"
15 #include "InsetBox.h"
16
17 #include "Buffer.h"
18 #include "BufferParams.h"
19 #include "Counters.h"
20 #include "Language.h"
21 #include "LaTeXFeatures.h"
22 #include "Layout.h"
23 #include "OutputParams.h"
24 #include "ParIterator.h"
25 #include "TextClass.h"
26 #include "TocBackend.h"
27
28 #include "support/debug.h"
29 #include "support/docstream.h"
30 #include "support/gettext.h"
31 #include "support/lstrings.h"
32
33 using namespace std;
34
35 namespace lyx {
36
InsetFoot(Buffer * buf)37 InsetFoot::InsetFoot(Buffer * buf)
38 : InsetFootlike(buf), intitle_(false), infloattable_(false)
39 {}
40
41
layoutName() const42 docstring InsetFoot::layoutName() const
43 {
44 if (intitle_)
45 return from_ascii("Foot:InTitle");
46 else if (infloattable_)
47 return from_ascii("Foot:InFloatTable");
48 return from_ascii("Foot");
49 }
50
51
updateBuffer(ParIterator const & it,UpdateType utype)52 void InsetFoot::updateBuffer(ParIterator const & it, UpdateType utype)
53 {
54 BufferParams const & bp = buffer().masterBuffer()->params();
55 Counters & cnts = bp.documentClass().counters();
56 if (utype == OutputUpdate) {
57 // the footnote counter is local to this inset
58 cnts.saveLastCounter();
59 }
60
61 intitle_ = false;
62 infloattable_ = false;
63 bool intable = false;
64 if (it.innerInsetOfType(TABULAR_CODE) != 0)
65 intable = true;
66 if (it.innerInsetOfType(FLOAT_CODE) != 0)
67 infloattable_ = intable;
68 // If we are in a table in a float, but the table is also in a minipage,
69 // we do not use tablefootnote, since minipages provide their own footnotes.
70 if (intable && infloattable_ && it.innerInsetOfType(BOX_CODE) != 0) {
71 InsetBoxParams const & boxp =
72 static_cast<InsetBox*>(it.innerInsetOfType(BOX_CODE))->params();
73 if (boxp.inner_box && !boxp.use_parbox && !boxp.use_makebox)
74 infloattable_ = false;
75 }
76 for (size_type sl = 0 ; sl < it.depth() ; ++sl) {
77 if (it[sl].text() && it[sl].paragraph().layout().intitle) {
78 intitle_ = true;
79 break;
80 }
81 }
82
83 Language const * lang = it.paragraph().getParLanguage(bp);
84 InsetLayout const & il = getLayout();
85 docstring const & count = il.counter();
86 custom_label_ = translateIfPossible(il.labelstring());
87
88 Paragraph const & par = it.paragraph();
89 if (!par.isDeleted(it.pos())) {
90 if (cnts.hasCounter(count))
91 cnts.step(count, utype);
92 custom_label_ += ' ' + cnts.theCounter(count, lang->code());
93 } else
94 custom_label_ += ' ' + from_ascii("#");
95 setLabel(custom_label_);
96
97 InsetCollapsible::updateBuffer(it, utype);
98 if (utype == OutputUpdate)
99 cnts.restoreLastCounter();
100 }
101
102
toolTip(BufferView const & bv,int x,int y) const103 docstring InsetFoot::toolTip(BufferView const & bv, int x, int y) const
104 {
105 if (isOpen(bv))
106 // this will give us something useful if there is no button
107 return InsetCollapsible::toolTip(bv, x, y);
108 return toolTipText(custom_label_+ ": ");
109 }
110
111
plaintext(odocstringstream & os,OutputParams const & runparams,size_t max_length) const112 int InsetFoot::plaintext(odocstringstream & os,
113 OutputParams const & runparams, size_t max_length) const
114 {
115 os << '[' << buffer().B_("footnote") << ":\n";
116 InsetText::plaintext(os, runparams, max_length);
117 os << "\n]";
118
119 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
120 }
121
122
docbook(odocstream & os,OutputParams const & runparams) const123 int InsetFoot::docbook(odocstream & os, OutputParams const & runparams) const
124 {
125 os << "<footnote>";
126 int const i = InsetText::docbook(os, runparams);
127 os << "</footnote>";
128
129 return i;
130 }
131
132
validate(LaTeXFeatures & features) const133 void InsetFoot::validate(LaTeXFeatures & features) const
134 {
135 // Use footnote package to provide footnotes in tables
136 // unless an alternative approach is built in the class.
137 if (!features.saveNoteEnv().empty()
138 && !features.isProvided("footnote-alternative")) {
139 features.require("footnote");
140 features.addPreambleSnippet(
141 from_ascii("\\makesavenoteenv{"
142 + features.saveNoteEnv()
143 + "}\n"));
144 }
145
146 InsetText::validate(features);
147 }
148
149 } // namespace lyx
150