src/insets/InsetFoot.cpp

   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
  16 #include "Buffer.h"
  17 #include "BufferParams.h"
  18 #include "Counters.h"
  19 #include "support/gettext.h"
  20 #include "Layout.h"
  21 // FIXME: the following is needed just to get the layout of the enclosing
  22 // paragraph. This seems a bit too much to me (JMarc)
  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/lstrings.h"
  30
  31 #include <ostream>
  32
  33 using namespace std;
  34
  35 namespace lyx {
  36
  37
  38 InsetFoot::InsetFoot(BufferParams const & bp)
  39         : InsetFootlike(bp)
  40 {}
  41
  42
  43 InsetFoot::InsetFoot(InsetFoot const & in)
  44         : InsetFootlike(in)
  45 {}
  46
  47
  48 Inset * InsetFoot::clone() const
  49 {
  50         return new InsetFoot(*this);
  51 }
  52
  53
  54 docstring InsetFoot::editMessage() const
  55 {
  56         return _("Opened Footnote Inset");
  57 }
  58
  59
  60 void InsetFoot::updateLabels(ParIterator const & it)
  61 {
  62         DocumentClass const & tclass = buffer().params().documentClass();
  63         Counters & cnts = tclass.counters();
  64         docstring const foot = from_ascii("footnote");
  65         Paragraph const & outer =  it.paragraph();
  66         if (!outer.layout()->intitle && cnts.hasCounter(foot)) {
  67                 cnts.step(foot);
  68                 // FIXME: the counter should format itself.
  69                 setLabel(support::bformat(from_ascii("%1$s %2$s"),
  70                                           getLayout(buffer().params()).labelstring(),
  71                                           cnts.theCounter(foot)));
  72
  73         }
  74         InsetCollapsable::updateLabels(it);
  75 }
  76
  77
  78 void InsetFoot::addToToc(ParConstIterator const & cpit) const
  79 {
  80         ParConstIterator pit = cpit;
  81         pit.push_back(*this);
  82
  83         Toc & toc = buffer().tocBackend().toc("footnote");
  84         // FIXME: we probably want the footnote number too.
  85         docstring str;
  86         str = getNewLabel(str);
  87         toc.push_back(TocItem(pit, 0, str));
  88 }
  89
  90
  91 int InsetFoot::latex(odocstream & os, OutputParams const & runparams_in) const
  92 {
  93         OutputParams runparams = runparams_in;
  94         // footnotes in titling commands like \title have moving arguments
  95         runparams.moving_arg |= runparams_in.intitle;
  96
  97         // in titling commands, \thanks should be used instead of \footnote.
  98         // some classes (e.g. memoir) do not understand \footnote.
  99         if (runparams_in.intitle)
 100                 os << "%\n\\thanks{";
 101         else
 102                 os << "%\n\\footnote{";
 103
 104         int const i = InsetText::latex(os, runparams);
 105         os << "%\n}";
 106         runparams_in.encoding = runparams.encoding;
 107
 108         return i + 2;
 109 }
 110
 111
 112 int InsetFoot::plaintext(odocstream & os, OutputParams const & runparams) const
 113 {
 114         os << '[' << buffer().B_("footnote") << ":\n";
 115         InsetText::plaintext(os, runparams);
 116         os << "\n]";
 117
 118         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 119 }
 120
 121
 122 int InsetFoot::docbook(odocstream & os, OutputParams const & runparams) const
 123 {
 124         os << "<footnote>";
 125         int const i = InsetText::docbook(os, runparams);
 126         os << "</footnote>";
 127
 128         return i;
 129 }
 130
 131
 132 } // namespace lyx