2 * \file InsetFloatList.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "InsetFloatList.h"
16 #include "BufferParams.h"
18 #include "DispatchResult.h"
20 #include "FloatList.h"
21 #include "FuncRequest.h"
23 #include "LaTeXFeatures.h"
25 #include "MetricsInfo.h"
26 #include "TocBackend.h"
28 #include "support/lstrings.h"
33 using support::bformat;
40 InsetFloatList::InsetFloatList()
41 : InsetCommand(InsetCommandParams(FLOAT_LIST_CODE), "toc")
45 InsetFloatList::InsetFloatList(string const & type)
46 : InsetCommand(InsetCommandParams(FLOAT_LIST_CODE), "toc")
48 setParam("type", from_ascii(type));
52 CommandInfo const * InsetFloatList::findInfo(std::string const & /* cmdName */)
54 static const char * const paramnames[] = {"type", ""};
55 static const bool isoptional[] = {false};
56 static const CommandInfo info = {1, paramnames, isoptional};
62 bool InsetFloatList::isCompatibleCommand(std::string const & s) {
63 std::string str = s.substr(0, 6);
64 return str == "listof";
68 docstring const InsetFloatList::getScreenLabel(Buffer const & buf) const
70 FloatList const & floats = buf.params().getTextClass().floats();
71 FloatList::const_iterator it = floats[to_ascii(getParam("type"))];
72 if (it != floats.end())
73 return buf.B_(it->second.listName());
75 return _("ERROR: Nonexistent float type!");
79 void InsetFloatList::write(Buffer const &, ostream & os) const
81 os << "FloatList " << to_ascii(getParam("type")) << "\n";
85 void InsetFloatList::read(Buffer const & buf, Lexer & lex)
87 FloatList const & floats = buf.params().getTextClass().floats();
91 setParam("type", lex.getDocString());
92 LYXERR(Debug::INSETS) << "FloatList::float_type: "
93 << to_ascii(getParam("type")) << endl;
94 if (!floats.typeExist(to_ascii(getParam("type"))))
95 lex.printError("InsetFloatList: Unknown float type: `$$Token'");
97 lex.printError("InsetFloatList: Parse error: `$$Token'");
100 token = lex.getString();
101 if (token == "\\end_inset")
104 if (token != "\\end_inset") {
105 lex.printError("Missing \\end_inset at this point. "
111 int InsetFloatList::latex(Buffer const & buf, odocstream & os,
112 OutputParams const &) const
114 FloatList const & floats = buf.params().getTextClass().floats();
115 FloatList::const_iterator cit = floats[to_ascii(getParam("type"))];
117 if (cit != floats.end()) {
118 if (cit->second.builtin()) {
119 // Only two different types allowed here:
120 string const type = cit->second.type();
121 if (type == "table") {
122 os << "\\listoftables\n";
123 } else if (type == "figure") {
124 os << "\\listoffigures\n";
126 os << "%% unknown builtin float\n";
129 os << "\\listof{" << getParam("type") << "}{"
130 << buf.B_(cit->second.listName()) << "}\n";
133 os << "%%\\listof{" << getParam("type") << "}{"
134 << bformat(_("List of %1$s"), from_utf8(cit->second.name()))
141 int InsetFloatList::plaintext(Buffer const & buffer, odocstream & os,
142 OutputParams const &) const
144 os << getScreenLabel(buffer) << "\n\n";
146 buffer.tocBackend().writePlaintextTocList(to_ascii(getParam("type")), os);
148 return PLAINTEXT_NEWLINE;
152 void InsetFloatList::validate(LaTeXFeatures & features) const
154 features.useFloat(to_ascii(getParam("type")));