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