]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetFoot.cpp
cprotect: don't consider content in Notes, deactivated branches etc.
[lyx.git] / src / insets / InsetFoot.cpp
index 6c0d9b79245fba635b6ec2e78bf9599496607876..29890d136523a4845b3ad3e91ef9d8b41d4ea190 100644 (file)
 #include <config.h>
 
 #include "InsetFoot.h"
+#include "InsetBox.h"
 
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "Counters.h"
 #include "Language.h"
+#include "LaTeXFeatures.h"
 #include "Layout.h"
 #include "OutputParams.h"
 #include "ParIterator.h"
@@ -32,86 +34,81 @@ using namespace std;
 
 namespace lyx {
 
-using support::bformat;
-
-InsetFoot::InsetFoot(Buffer const & buf)
-       : InsetFootlike(buf)
+InsetFoot::InsetFoot(Buffer * buf)
+       : InsetFootlike(buf), intitle_(false), infloattable_(false)
 {}
 
 
-docstring InsetFoot::editMessage() const
+docstring InsetFoot::layoutName() const
 {
-       return _("Opened Footnote Inset");
+       if (intitle_)
+               return from_ascii("Foot:InTitle");
+       else if (infloattable_)
+               return from_ascii("Foot:InFloatTable");
+       return from_ascii("Foot");
 }
 
 
-void InsetFoot::updateLabels(ParIterator const & it)
+void InsetFoot::updateBuffer(ParIterator const & it, UpdateType utype)
 {
        BufferParams const & bp = buffer().masterBuffer()->params();
        Counters & cnts = bp.documentClass().counters();
-       docstring const foot = from_ascii("footnote");
-       Paragraph const & outer =  it.paragraph();
-       if (!outer.layout().intitle && cnts.hasCounter(foot)) {
-               cnts.step(foot);
-               // FIXME: the counter should format itself.
-               custom_label_= bformat(from_utf8("%1$s %2$s"),
-                                      translateIfPossible(getLayout(bp).labelstring()),
-                                      cnts.theCounter(foot, outer.getParLanguage(bp)->code()));
-               setLabel(custom_label_);
-       
+       if (utype == OutputUpdate) {
+               // the footnote counter is local to this inset
+               cnts.saveLastCounter();
        }
-       InsetCollapsable::updateLabels(it);
-}
 
+       intitle_ = false;
+       infloattable_ = false;
+       bool intable = false;
+       if (it.innerInsetOfType(TABULAR_CODE) != 0)
+               intable = true;
+       if (it.innerInsetOfType(FLOAT_CODE) != 0)
+               infloattable_ = intable;
+       // If we are in a table in a float, but the table is also in a minipage,
+       // we do not use tablefootnote, since minipages provide their own footnotes.
+       if (intable && infloattable_ && it.innerInsetOfType(BOX_CODE) != 0) {
+               InsetBoxParams const & boxp =
+                               static_cast<InsetBox*>(it.innerInsetOfType(BOX_CODE))->params();
+               if (boxp.inner_box && !boxp.use_parbox && !boxp.use_makebox)
+                       infloattable_ = false;
+       }
+       for (size_type sl = 0 ; sl < it.depth() ; ++sl) {
+               if (it[sl].text() && it[sl].paragraph().layout().intitle) {
+                       intitle_ = true;
+                       break;
+               }
+       }
 
-void InsetFoot::addToToc(DocIterator const & cpit)
-{
-       DocIterator pit = cpit;
-       pit.push_back(CursorSlice(*this));
-
-       Toc & toc = buffer().tocBackend().toc("footnote");
-       docstring str;
-       str = custom_label_ + ": " + getNewLabel(str);
-       toc.push_back(TocItem(pit, 0, str));
-       // Proceed with the rest of the inset.
-       InsetFootlike::addToToc(cpit);
+       Language const * lang = it.paragraph().getParLanguage(bp);
+       InsetLayout const & il = getLayout();
+       docstring const & count = il.counter();
+       custom_label_ = translateIfPossible(il.labelstring());
+       if (cnts.hasCounter(count))
+               cnts.step(count, utype);
+       custom_label_ += ' ' + cnts.theCounter(count, lang->code());
+       setLabel(custom_label_);
+
+       InsetCollapsible::updateBuffer(it, utype);
+       if (utype == OutputUpdate)
+               cnts.restoreLastCounter();
 }
 
 
 docstring InsetFoot::toolTip(BufferView const & bv, int x, int y) const
 {
-       docstring default_tip = InsetCollapsable::toolTip(bv, x, y);
-       if (!isOpen(bv))
-               return custom_label_ + "\n" + default_tip;
-       return default_tip;
+       if (isOpen(bv))
+               // this will give us something useful if there is no button
+               return InsetCollapsible::toolTip(bv, x, y);
+       return toolTipText(custom_label_+ ": ");
 }
 
 
-int InsetFoot::latex(odocstream & os, OutputParams const & runparams_in) const
-{
-       OutputParams runparams = runparams_in;
-       // footnotes in titling commands like \title have moving arguments
-       runparams.moving_arg |= runparams_in.intitle;
-
-       // in titling commands, \thanks should be used instead of \footnote.
-       // some classes (e.g. memoir) do not understand \footnote.
-       if (runparams_in.intitle)
-               os << "%\n\\thanks{";
-       else
-               os << "%\n\\footnote{";
-
-       int const i = InsetText::latex(os, runparams);
-       os << "%\n}";
-       runparams_in.encoding = runparams.encoding;
-
-       return i + 2;
-}
-
-
-int InsetFoot::plaintext(odocstream & os, OutputParams const & runparams) const
+int InsetFoot::plaintext(odocstringstream & os,
+        OutputParams const & runparams, size_t max_length) const
 {
        os << '[' << buffer().B_("footnote") << ":\n";
-       InsetText::plaintext(os, runparams);
+       InsetText::plaintext(os, runparams, max_length);
        os << "\n]";
 
        return PLAINTEXT_NEWLINE + 1; // one char on a separate line
@@ -127,4 +124,21 @@ int InsetFoot::docbook(odocstream & os, OutputParams const & runparams) const
        return i;
 }
 
+
+void InsetFoot::validate(LaTeXFeatures & features) const
+{
+       // Use footnote package to provide footnotes in tables
+       // unless an alternative approach is built in the class.
+       if (!features.saveNoteEnv().empty()
+           && !features.isProvided("footnote-alternative")) {
+               features.require("footnote");
+               features.addPreambleSnippet(
+                       from_ascii("\\makesavenoteenv{"
+                                  + features.saveNoteEnv()
+                                  + "}\n"));
+       }
+
+       InsetText::validate(features);
+}
+
 } // namespace lyx