]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetFloatList.cpp
Loop refactoring
[lyx.git] / src / insets / InsetFloatList.cpp
index c43a64a03446b3c4ef4906917ef65bdbe96cb6ef..e711feebf4c6db3e397a2c441fcb48111cf5d0c4 100644 (file)
@@ -3,7 +3,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "Buffer.h"
 #include "BufferParams.h"
-#include "debug.h"
+#include "BufferView.h"
+#include "Cursor.h"
 #include "DispatchResult.h"
 #include "Floating.h"
 #include "FloatList.h"
+#include "Font.h"
 #include "FuncRequest.h"
-#include "gettext.h"
+#include "Language.h"
 #include "LaTeXFeatures.h"
-#include "LyXLex.h"
-#include "MetricsInfo.h"
+#include "Lexer.h"
+#include "Paragraph.h"
+#include "output_xhtml.h"
+#include "texstream.h"
+#include "TextClass.h"
 #include "TocBackend.h"
 
+#include "support/debug.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 
+#include <ostream>
 
-namespace lyx {
-
-using support::bformat;
+using namespace std;
+using namespace lyx::support;
 
-using std::endl;
-using std::string;
-using std::ostream;
+namespace lyx {
 
 
-InsetFloatList::InsetFloatList()
-       : InsetCommand(InsetCommandParams("floatlist"), "toc")
+InsetFloatList::InsetFloatList(Buffer * buf)
+       : InsetCommand(buf, InsetCommandParams(FLOAT_LIST_CODE))
 {}
 
 
-InsetFloatList::InsetFloatList(string const & type)
-       : InsetCommand(InsetCommandParams("floatlist"), "toc")
+InsetFloatList::InsetFloatList(Buffer * buf, string const & type)
+       : InsetCommand(buf, InsetCommandParams(FLOAT_LIST_CODE))
 {
        setParam("type", from_ascii(type));
 }
 
 
-docstring const InsetFloatList::getScreenLabel(Buffer const & buf) const
+ParamInfo const & InsetFloatList::findInfo(string const & /* cmdName */)
+{
+       static ParamInfo param_info_;
+       if (param_info_.empty()) {
+               param_info_.add("type", ParamInfo::LATEX_REQUIRED);
+       }
+       return param_info_;
+}
+
+
+//HACK
+bool InsetFloatList::isCompatibleCommand(string const & s)
+{
+       string str = s.substr(0, 6);
+       return str == "listof";
+}
+
+
+docstring InsetFloatList::screenLabel() const
 {
-       FloatList const & floats = buf.params().getLyXTextClass().floats();
+       FloatList const & floats = buffer().params().documentClass().floats();
        FloatList::const_iterator it = floats[to_ascii(getParam("type"))];
        if (it != floats.end())
-               return buf.B_(it->second.listName());
+               return buffer().B_(it->second.listName());
        else
                return _("ERROR: Nonexistent float type!");
 }
 
 
-InsetBase::Code InsetFloatList::lyxCode() const
-{
-       return InsetBase::FLOAT_LIST_CODE;
+void InsetFloatList::doDispatch(Cursor & cur, FuncRequest & cmd) {
+       switch (cmd.action()) {
+       case LFUN_MOUSE_RELEASE:
+               if (!cur.selection() && cmd.button() == mouse_button::button1) {
+                       cur.bv().showDialog("toc", params2string(params()));
+                       cur.dispatched();
+               }
+               break;
+
+       default:
+               InsetCommand::doDispatch(cur, cmd);
+       }
 }
 
 
-void InsetFloatList::write(Buffer const &, ostream & os) const
+void InsetFloatList::write(ostream & os) const
 {
        os << "FloatList " << to_ascii(getParam("type")) << "\n";
 }
 
 
-void InsetFloatList::read(Buffer const & buf, LyXLex & lex)
+void InsetFloatList::read(Lexer & lex)
 {
-       FloatList const & floats = buf.params().getLyXTextClass().floats();
+       lex.setContext("InsetFloatList::read");
+       FloatList const & floats = buffer().params().documentClass().floats();
        string token;
 
        if (lex.eatLine()) {
                setParam("type", lex.getDocString());
-               LYXERR(Debug::INSETS) << "FloatList::float_type: "
-                                     << to_ascii(getParam("type")) << endl;
+               LYXERR(Debug::INSETS, "FloatList::float_type: "
+                                     << to_ascii(getParam("type")));
                if (!floats.typeExist(to_ascii(getParam("type"))))
-                       lex.printError("InsetFloatList: Unknown float type: `$$Token'");
-       } else
-               lex.printError("InsetFloatList: Parse error: `$$Token'");
+                       lex.printError("Unknown float type");
+       } else {
+               lex.printError("Parse error");
+       }
+
        while (lex.isOK()) {
                lex.next();
                token = lex.getString();
@@ -92,56 +127,156 @@ void InsetFloatList::read(Buffer const & buf, LyXLex & lex)
                        break;
        }
        if (token != "\\end_inset") {
-               lex.printError("Missing \\end_inset at this point. "
-                              "Read: `$$Token'");
+               lex.printError("Missing \\end_inset at this point.");
        }
 }
 
 
-int InsetFloatList::latex(Buffer const & buf, odocstream & os,
-                          OutputParams const &) const
+void InsetFloatList::latex(otexstream & os, OutputParams const &) const
 {
-       FloatList const & floats = buf.params().getLyXTextClass().floats();
+       FloatList const & floats = buffer().params().documentClass().floats();
        FloatList::const_iterator cit = floats[to_ascii(getParam("type"))];
 
        if (cit != floats.end()) {
-               if (cit->second.builtin()) {
-                       // Only two different types allowed here:
-                       string const type = cit->second.type();
-                       if (type == "table") {
-                               os << "\\listoftables\n";
-                       } else if (type == "figure") {
-                               os << "\\listoffigures\n";
-                       } else {
-                               os << "%% unknown builtin float\n";
-                       }
-               } else {
+               Floating const & fl = cit->second;
+               if (fl.usesFloatPkg()) {
+                       docstring const name =
+                               buffer().language()->translateLayout(fl.listName());
                        os << "\\listof{" << getParam("type") << "}{"
-                          << buf.B_(cit->second.listName()) << "}\n";
+                          << name << "}\n";
+               } else {
+                       if (!fl.listCommand().empty())
+                               os << "\\" << from_ascii(fl.listCommand()) << "\n";
+                       else
+                               os << "%% "
+                                  << bformat(_("LyX cannot generate a list of %1$s"), getParam("type"))
+                                  << "\n";
                }
        } else {
+               string const flName = "List of " + to_utf8(getParam("type"));
+               docstring const name = buffer().language()->translateLayout(flName);
                os << "%%\\listof{" << getParam("type") << "}{"
-                  << bformat(_("List of %1$s"), from_utf8(cit->second.name()))
-                  << "}\n";
+                  << name << "}\n";
        }
-       return 1;
 }
 
 
-int InsetFloatList::plaintext(Buffer const & buffer, odocstream & os,
-                              OutputParams const &) const
+int InsetFloatList::plaintext(odocstringstream & os,
+        OutputParams const &, size_t max_length) const
 {
-       os << getScreenLabel(buffer) << "\n\n";
+       os << screenLabel() << "\n\n";
 
-       buffer.tocBackend().writePlaintextTocList(to_ascii(getParam("type")), os);
+       buffer().tocBackend().writePlaintextTocList(to_ascii(getParam("type")), os, max_length);
 
        return PLAINTEXT_NEWLINE;
 }
 
 
+docstring InsetFloatList::xhtml(XMLStream &, OutputParams const & op) const {
+       FloatList const & floats = buffer().params().documentClass().floats();
+       FloatList::const_iterator cit = floats[to_ascii(getParam("type"))];
+
+       if (cit == floats.end()) {
+               LYXERR0("Unknown float type `" << getParam("type") << "' in IFL::xhtml.");
+               return docstring();
+       }
+
+       string toctype;
+       docstring toclabel;
+       // FIXME
+       // Other builtin floats should be handled here. But I'm not sure if that is
+       // even possible yet, since I'm not sure if we have a TOC for such things.
+       // If so, then they should define ListName, as non-builtin floats do, and
+       // then we can use that.
+       // Really, all floats should define that.
+       if (cit->second.isPredefined()) {
+               // Only two different types allowed here:
+               string const type = cit->second.floattype();
+               if (type == "table") {
+                       toctype = "table";
+                       toclabel = translateIfPossible(from_ascii("List of Tables"),
+                                                      op.local_font->language()->lang());
+               } else if (type == "figure") {
+                       toctype = "figure";
+                       toclabel = translateIfPossible(from_ascii("List of Figures"),
+                                                      op.local_font->language()->lang());
+               } else {
+                       LYXERR0("Unknown Builtin Float!");
+                       return docstring();
+               }
+       } else {
+               toctype = to_utf8(getParam("type"));
+               toclabel = translateIfPossible(from_utf8(cit->second.listName()),
+                                              op.local_font->language()->lang());
+       }
+
+       shared_ptr<Toc const> toc = buffer().tocBackend().toc(toctype);
+       if (toc->empty())
+               return docstring();
+
+       // we want to look like a chapter, section, or whatever.
+       // so we're going to look for the layout with the minimum toclevel
+       // number > 0---because we don't want Part.
+       // we'll take the first one, just because.
+       // FIXME This could be specified in the layout file.
+       DocumentClass const & dc = buffer().params().documentClass();
+       TextClass::LayoutList::const_iterator lit = dc.begin();
+       TextClass::LayoutList::const_iterator len = dc.end();
+       int minlevel = 1000;
+       Layout const * lay = nullptr;
+       for (; lit != len; ++lit) {
+               int const level = lit->toclevel;
+               if (level > 0 && (level == Layout::NOT_IN_TOC || level >= minlevel))
+                       continue;
+               lay = &*lit;
+               minlevel = level;
+       }
+
+       string const tocclass = lay ? " " + lay->defaultCSSClass(): "";
+       string const tocattr = "class='tochead toc-" + toctype + tocclass + "'";
+
+       // we'll use our own stream, because we are going to defer everything.
+       // that's how we deal with the fact that we're probably inside a standard
+       // paragraph, and we don't want to be.
+       odocstringstream ods;
+       XMLStream xs(ods);
+
+       InsetLayout const & il = getLayout();
+       string const & tag = il.htmltag();
+       xs << xml::StartTag("div", "class='toc toc-floats'");
+       xs << xml::StartTag(tag, tocattr)
+                << toclabel
+                << xml::EndTag(tag);
+
+       Toc::const_iterator it = toc->begin();
+       Toc::const_iterator const en = toc->end();
+       for (; it != en; ++it) {
+               if (it->str().empty())
+                       continue;
+               Paragraph const & par = it->dit().innerParagraph();
+               string const attr = "class='lyxtoc-floats lyxtoc-" + toctype + "'";
+               xs << xml::StartTag("div", attr);
+               string const parattr = "href='#" + par.magicLabel() + "' class='lyxtoc-floats'";
+               xs << xml::StartTag("a", parattr)
+                  << it->str()
+                  << xml::EndTag("a");
+               xs << xml::EndTag("div");
+       }
+       xs << xml::EndTag("div");
+       return ods.str();
+}
+
+
 void InsetFloatList::validate(LaTeXFeatures & features) const
 {
        features.useFloat(to_ascii(getParam("type")));
+       features.useInsetLayout(getLayout());
+}
+
+
+docstring InsetFloatList::layoutName() const
+{
+       return "FloatList:" + getParam("type");
 }