src/insets/InsetFloatList.cpp

   1 /**
   2  * \file InsetFloatList.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 "InsetFloatList.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "DispatchResult.h"
  18 #include "Floating.h"
  19 #include "FloatList.h"
  20 #include "Font.h"
  21 #include "Language.h"
  22 #include "LaTeXFeatures.h"
  23 #include "Lexer.h"
  24 #include "Paragraph.h"
  25 #include "output_xhtml.h"
  26 #include "TextClass.h"
  27 #include "TocBackend.h"
  28
  29 #include "support/debug.h"
  30 #include "support/gettext.h"
  31 #include "support/lstrings.h"
  32
  33 #include <ostream>
  34
  35 using namespace std;
  36 using namespace lyx::support;
  37
  38 namespace lyx {
  39
  40
  41 InsetFloatList::InsetFloatList(Buffer * buf)
  42         : InsetCommand(buf, InsetCommandParams(FLOAT_LIST_CODE))
  43 {}
  44
  45
  46 InsetFloatList::InsetFloatList(Buffer * buf, string const & type)
  47         : InsetCommand(buf, InsetCommandParams(FLOAT_LIST_CODE))
  48 {
  49         setParam("type", from_ascii(type));
  50 }
  51
  52
  53 ParamInfo const & InsetFloatList::findInfo(string const & /* cmdName */)
  54 {
  55         static ParamInfo param_info_;
  56         if (param_info_.empty()) {
  57                 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
  58         }
  59         return param_info_;
  60 }
  61
  62
  63 //HACK
  64 bool InsetFloatList::isCompatibleCommand(string const & s)
  65 {
  66         string str = s.substr(0, 6);
  67         return str == "listof";
  68 }
  69
  70
  71 docstring InsetFloatList::screenLabel() const
  72 {
  73         FloatList const & floats = buffer().params().documentClass().floats();
  74         FloatList::const_iterator it = floats[to_ascii(getParam("type"))];
  75         if (it != floats.end())
  76                 return buffer().B_(it->second.listName());
  77         else
  78                 return _("ERROR: Nonexistent float type!");
  79 }
  80
  81
  82 void InsetFloatList::write(ostream & os) const
  83 {
  84         os << "FloatList " << to_ascii(getParam("type")) << "\n";
  85 }
  86
  87
  88 void InsetFloatList::read(Lexer & lex)
  89 {
  90         lex.setContext("InsetFloatList::read");
  91         FloatList const & floats = buffer().params().documentClass().floats();
  92         string token;
  93
  94         if (lex.eatLine()) {
  95                 setParam("type", lex.getDocString());
  96                 LYXERR(Debug::INSETS, "FloatList::float_type: "
  97                                       << to_ascii(getParam("type")));
  98                 if (!floats.typeExist(to_ascii(getParam("type"))))
  99                         lex.printError("Unknown float type");
 100         } else {
 101                 lex.printError("Parse error");
 102         }
 103
 104         while (lex.isOK()) {
 105                 lex.next();
 106                 token = lex.getString();
 107                 if (token == "\\end_inset")
 108                         break;
 109         }
 110         if (token != "\\end_inset") {
 111                 lex.printError("Missing \\end_inset at this point.");
 112         }
 113 }
 114
 115
 116 void InsetFloatList::latex(otexstream & os, OutputParams const &) const
 117 {
 118         FloatList const & floats = buffer().params().documentClass().floats();
 119         FloatList::const_iterator cit = floats[to_ascii(getParam("type"))];
 120
 121         if (cit != floats.end()) {
 122                 Floating const & fl = cit->second;
 123                 if (fl.usesFloatPkg()) {
 124                         docstring const name =
 125                                 buffer().language()->translateLayout(fl.listName());
 126                         os << "\\listof{" << getParam("type") << "}{"
 127                            << name << "}\n";
 128                 } else {
 129                         if (!fl.listCommand().empty())
 130                                 os << "\\" << from_ascii(fl.listCommand()) << "\n";
 131                         else
 132                                 os << "%% "
 133                                    << bformat(_("LyX cannot generate a list of %1$s"), getParam("type"))
 134                                    << "\n";
 135                 }
 136         } else {
 137                 string const flName = "List of " + to_utf8(getParam("type"));
 138                 docstring const name = buffer().language()->translateLayout(flName);
 139                 os << "%%\\listof{" << getParam("type") << "}{"
 140                    << name << "}\n";
 141         }
 142 }
 143
 144
 145 int InsetFloatList::plaintext(odocstream & os, OutputParams const &) const
 146 {
 147         os << screenLabel() << "\n\n";
 148
 149         buffer().tocBackend().writePlaintextTocList(to_ascii(getParam("type")), os);
 150
 151         return PLAINTEXT_NEWLINE;
 152 }
 153
 154
 155 docstring InsetFloatList::xhtml(XHTMLStream &, OutputParams const &) const {
 156         FloatList const & floats = buffer().params().documentClass().floats();
 157         FloatList::const_iterator cit = floats[to_ascii(getParam("type"))];
 158
 159         if (cit == floats.end()) {
 160                 LYXERR0("Unknown float type `" << getParam("type") << "' in IFL::xhtml.");
 161                 return docstring();
 162         }
 163
 164         string toctype;
 165         docstring toclabel;
 166         // FIXME
 167         // Other builtin floats should be handled here. But I'm not sure if that is
 168         // even possible yet, since I'm not sure if we have a TOC for such things.
 169         // If so, then they should define ListName, as non-builtin floats do, and
 170         // then we can use that.
 171         // Really, all floats should define that.
 172         if (cit->second.isPredefined()) {
 173                 // Only two different types allowed here:
 174                 string const type = cit->second.floattype();
 175                 if (type == "table") {
 176                         toctype = "table";
 177                         toclabel = _("List of Tables");
 178                 } else if (type == "figure") {
 179                         toctype = "figure";
 180                         toclabel = _("List of Figures");
 181                 } else {
 182                         LYXERR0("Unknown Builtin Float!");
 183                         return docstring();
 184                 }
 185         } else {
 186                 toctype = to_utf8(getParam("type"));
 187                 toclabel = buffer().B_(cit->second.listName());
 188         }
 189
 190         // FIXME Do we need to check if it exists? If so, we need a new
 191         // routine in TocBackend to do that.
 192         Toc const & toc = buffer().tocBackend().toc(toctype);
 193         if (toc.empty())
 194                 return docstring();
 195
 196         // we want to look like a chapter, section, or whatever.
 197         // so we're going to look for the layout with the minimum toclevel
 198         // number > 0---because we don't want Part.
 199         // we'll take the first one, just because.
 200         // FIXME This could be specified in the layout file.
 201         DocumentClass const & dc = buffer().params().documentClass();
 202         TextClass::LayoutList::const_iterator lit = dc.begin();
 203         TextClass::LayoutList::const_iterator len = dc.end();
 204         int minlevel = 1000;
 205         Layout const * lay = NULL;
 206         for (; lit != len; ++lit) {
 207                 int const level = lit->toclevel;
 208                 if (level > 0 && (level == Layout::NOT_IN_TOC || level >= minlevel))
 209                         continue;
 210                 lay = &*lit;
 211                 minlevel = level;
 212         }
 213
 214         string const tocclass = lay ? " " + lay->defaultCSSClass(): "";
 215         string const tocattr = "class='tochead + toc-" + toctype + " " + tocclass + "'";
 216
 217         // we'll use our own stream, because we are going to defer everything.
 218         // that's how we deal with the fact that we're probably inside a standard
 219         // paragraph, and we don't want to be.
 220         odocstringstream ods;
 221         XHTMLStream xs(ods);
 222
 223         xs << html::StartTag("div", "class='toc'");
 224         xs << html::StartTag("div", tocattr)
 225                  << toclabel
 226                  << html::EndTag("div");
 227
 228         Toc::const_iterator it = toc.begin();
 229         Toc::const_iterator const en = toc.end();
 230         for (; it != en; ++it) {
 231                 Paragraph const & par = it->dit().innerParagraph();
 232                 string const attr = "class='lyxtoc-" + toctype + "'";
 233                 Font const dummy;
 234                 xs << html::StartTag("div", attr);
 235                 string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
 236                 xs << it->str() << " "
 237                    << html::StartTag("a", parattr)
 238                    // FIXME XHTML
 239                    // There ought to be a simple way to customize this.
 240                    << XHTMLStream::ESCAPE_NONE << "&gt;"
 241                    << html::EndTag("a");
 242                 xs << html::EndTag("div");
 243         }
 244         xs << html::EndTag("div");
 245         return ods.str();
 246 }
 247
 248
 249 void InsetFloatList::validate(LaTeXFeatures & features) const
 250 {
 251         features.useFloat(to_ascii(getParam("type")));
 252 }
 253
 254
 255 } // namespace lyx