src/insets/insetfloat.C

   1 /**
   2  * \file insetfloat.C
   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 "insetfloat.h"
  15 #include "insettext.h"
  16
  17 #include "buffer.h"
  18 #include "BufferView.h"
  19 #include "debug.h"
  20 #include "Floating.h"
  21 #include "FloatList.h"
  22 #include "funcrequest.h"
  23 #include "gettext.h"
  24 #include "iterators.h"
  25 #include "LaTeXFeatures.h"
  26 #include "Lsstream.h"
  27 #include "lyxfont.h"
  28 #include "lyxlex.h"
  29 #include "lyxtext.h"
  30 #include "Lsstream.h"
  31
  32 #include "support/LOstream.h"
  33 #include "support/lstrings.h"
  34 #include "support/tostr.h"
  35
  36 #include "frontends/LyXView.h"
  37 #include "frontends/Dialogs.h"
  38
  39 using namespace lyx::support;
  40
  41 using std::ostream;
  42 using std::endl;
  43
  44
  45 // With this inset it will be possible to support the latex package
  46 // float.sty, and I am sure that with this and some additional support
  47 // classes we can support similar functionality in other formats
  48 // (read DocBook).
  49 // By using float.sty we will have the same handling for all floats, both
  50 // for those already in existance (table and figure) and all user created
  51 // ones¹. So suddenly we give the users the possibility of creating new
  52 // kinds of floats on the fly. (and with a uniform look)
  53 //
  54 // API to float.sty:
  55 //   \newfloat{type}{placement}{ext}[within]
  56 //     type      - The "type" of the new class of floats, like program or
  57 //                 algorithm. After the appropriate \newfloat, commands
  58 //                 such as \begin{program} or \end{algorithm*} will be
  59 //                 available.
  60 //     placement - The default placement for the given class of floats.
  61 //                 They are like in standard LaTeX: t, b, p and h for top,
  62 //                 bottom, page, and here, respectively. On top of that
  63 //                 there is a new type, H, which does not really correspond
  64 //                 to a float, since it means: put it "here" and nowhere else.
  65 //                 Note, however that the H specifier is special and, because
  66 //                 of implementation details cannot be used in the second
  67 //                 argument of \newfloat.
  68 //     ext       - The file name extension of an auxiliary file for the list
  69 //                 of figures (or whatever). LaTeX writes the captions to
  70 //                 this file.
  71 //     within    - This (optional) argument determines whether floats of this
  72 //                 class will be numbered within some sectional unit of the
  73 //                 document. For example, if within is equal to chapter, the
  74 //                 floats will be numbered within chapters.
  75 //   \floatstyle{style}
  76 //     style -  plain, boxed, ruled
  77 //   \floatname{float}{floatname}
  78 //     float     -
  79 //     floatname -
  80 //   \floatplacement{float}{placement}
  81 //     float     -
  82 //     placement -
  83 //   \restylefloat{float}
  84 //     float -
  85 //   \listof{type}{title}
  86 //     title -
  87
  88 // ¹ the algorithm float is defined using the float.sty package. Like this
  89 //   \floatstyle{ruled}
  90 //   \newfloat{algorithm}{htbp}{loa}[<sect>]
  91 //   \floatname{algorithm}{Algorithm}
  92 //
  93 // The intention is that floats should be definable from two places:
  94 //          - layout files
  95 //          - the "gui" (i.e. by the user)
  96 //
  97 // From layout files.
  98 // This should only be done for floats defined in a documentclass and that
  99 // does not need any additional packages. The two most known floats in this
 100 // category is "table" and "figure". Floats defined in layout files are only
 101 // stored in lyx files if the user modifies them.
 102 //
 103 // By the user.
 104 // There should be a gui dialog (and also a collection of lyxfuncs) where
 105 // the user can modify existing floats and/or create new ones.
 106 //
 107 // The individual floats will also have some settable
 108 // variables: wide and placement.
 109 //
 110 // Lgb
 111
 112 namespace {
 113
 114 // this should not be hardcoded, but be part of the definition
 115 // of the float (JMarc)
 116 string const caplayout("Caption");
 117
 118 string floatname(string const & type, BufferParams const & bp)
 119 {
 120         FloatList const & floats = bp.getLyXTextClass().floats();
 121         FloatList::const_iterator it = floats[type];
 122         if (it == floats.end())
 123                 return type;
 124
 125         return _(it->second.name());
 126 }
 127
 128 } // namespace anon
 129
 130
 131 InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
 132         : InsetCollapsable(bp)
 133 {
 134         string lab(_("float: "));
 135         lab += floatname(type, bp);
 136         setLabel(lab);
 137         LyXFont font(LyXFont::ALL_SANE);
 138         font.decSize();
 139         font.decSize();
 140         font.setColor(LColor::collapsable);
 141         setLabelFont(font);
 142         params_.type = type;
 143         setInsetName(type);
 144         LyXTextClass const & tclass = bp.getLyXTextClass();
 145         if (tclass.hasLayout(caplayout))
 146                 inset.paragraphs.begin()->layout(tclass[caplayout]);
 147 }
 148
 149
 150 InsetFloat::InsetFloat(InsetFloat const & in)
 151         : InsetCollapsable(in), params_(in.params_)
 152 {}
 153
 154
 155 InsetFloat::~InsetFloat()
 156 {
 157         InsetFloatMailer mailer(*this);
 158         mailer.hideDialog();
 159 }
 160
 161
 162 dispatch_result InsetFloat::localDispatch(FuncRequest const & cmd)
 163 {
 164         Inset::RESULT result = UNDISPATCHED;
 165
 166         switch (cmd.action) {
 167         case LFUN_INSET_MODIFY: {
 168                 InsetFloatParams params;
 169                 InsetFloatMailer::string2params(cmd.argument, params);
 170
 171                 params_.placement = params.placement;
 172                 params_.wide      = params.wide;
 173
 174                 wide(params_.wide, cmd.view()->buffer()->params);
 175                 cmd.view()->updateInset(this);
 176                 result = DISPATCHED;
 177         }
 178         break;
 179
 180         case LFUN_INSET_DIALOG_UPDATE: {
 181                 InsetFloatMailer mailer(*this);
 182                 mailer.updateDialog(cmd.view());
 183         }
 184         break;
 185
 186         default:
 187                 result = InsetCollapsable::localDispatch(cmd);
 188         }
 189
 190         return result;
 191 }
 192
 193
 194 void InsetFloatParams::write(ostream & os) const
 195 {
 196         os << "Float " // getInsetName()
 197            << type << '\n';
 198
 199         if (!placement.empty()) {
 200                 os << "placement " << placement << "\n";
 201         }
 202         if (wide) {
 203                 os << "wide true\n";
 204         } else {
 205                 os << "wide false\n";
 206         }
 207 }
 208
 209
 210 void InsetFloatParams::read(LyXLex & lex)
 211 {
 212         if (lex.isOK()) {
 213                 lex.next();
 214                 string token = lex.getString();
 215                 if (token == "placement") {
 216                         lex.next();
 217                         placement = lex.getString();
 218                 } else {
 219                         // take countermeasures
 220                         lex.pushToken(token);
 221                 }
 222                 lex.next();
 223                 token = lex.getString();
 224                 if (token == "wide") {
 225                         lex.next();
 226                         string const tmptoken = lex.getString();
 227                         wide = (tmptoken == "true");
 228                 } else {
 229                         lyxerr << "InsetFloat::Read:: Missing wide!"
 230                                << endl;
 231                         // take countermeasures
 232                         lex.pushToken(token);
 233                 }
 234         }
 235 }
 236
 237
 238 void InsetFloat::write(Buffer const * buf, ostream & os) const
 239 {
 240         params_.write(os);
 241         InsetCollapsable::write(buf, os);
 242 }
 243
 244
 245 void InsetFloat::read(Buffer const * buf, LyXLex & lex)
 246 {
 247         params_.read(lex);
 248         wide(params_.wide, buf->params);
 249         InsetCollapsable::read(buf, lex);
 250 }
 251
 252
 253 void InsetFloat::validate(LaTeXFeatures & features) const
 254 {
 255         if (contains(params_.placement, "H")) {
 256                 features.require("float");
 257         }
 258
 259         features.useFloat(params_.type);
 260         InsetCollapsable::validate(features);
 261 }
 262
 263
 264 InsetBase * InsetFloat::clone() const
 265 {
 266         return new InsetFloat(*this);
 267 }
 268
 269
 270 string const InsetFloat::editMessage() const
 271 {
 272         return _("Opened Float Inset");
 273 }
 274
 275
 276 int InsetFloat::latex(Buffer const * buf, ostream & os,
 277                       LatexRunParams const & runparams) const
 278 {
 279         FloatList const & floats = buf->params.getLyXTextClass().floats();
 280         string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
 281         // Figure out the float placement to use.
 282         // From lowest to highest:
 283         // - float default placement
 284         // - document wide default placement
 285         // - specific float placement
 286         string placement;
 287         string const buf_placement = buf->params.float_placement;
 288         string const def_placement = floats.defaultPlacement(params_.type);
 289         if (!params_.placement.empty()
 290             && params_.placement != def_placement) {
 291                 placement = params_.placement;
 292         } else if (params_.placement.empty()
 293                    && !buf_placement.empty()
 294                    && buf_placement != def_placement) {
 295                 placement = buf_placement;
 296         }
 297
 298         // The \n is used to force \begin{<floatname>} to appear in a new line.
 299         // The % is needed to prevent two consecutive \n chars in the case
 300         // when the current output line is empty.
 301         os << "%\n\\begin{" << tmptype << '}';
 302         // We only output placement if different from the def_placement.
 303         if (!placement.empty()) {
 304                 os << '[' << placement << ']';
 305         }
 306         os << '\n';
 307
 308         int const i = inset.latex(buf, os, runparams);
 309
 310         // The \n is used to force \end{<floatname>} to appear in a new line.
 311         // In this case, we do not case if the current output line is empty.
 312         os << "\n\\end{" << tmptype << "}\n";
 313
 314         return i + 4;
 315 }
 316
 317
 318 int InsetFloat::docbook(Buffer const * buf, ostream & os, bool mixcont) const
 319 {
 320         os << '<' << params_.type << '>';
 321         int const i = inset.docbook(buf, os, mixcont);
 322         os << "</" << params_.type << '>';
 323
 324         return i;
 325 }
 326
 327
 328 bool InsetFloat::insetAllowed(Inset::Code code) const
 329 {
 330         if (code == Inset::FLOAT_CODE)
 331                 return false;
 332         if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
 333                 return inset.insetAllowed(code);
 334         if ((code == Inset::FOOT_CODE) || (code == Inset::MARGIN_CODE))
 335                 return false;
 336         return true;
 337 }
 338
 339
 340 bool InsetFloat::showInsetDialog(BufferView * bv) const
 341 {
 342         if (!inset.showInsetDialog(bv)) {
 343                 InsetFloat * tmp = const_cast<InsetFloat *>(this);
 344                 InsetFloatMailer mailer(*tmp);
 345                 mailer.showDialog(bv);
 346         }
 347         return true;
 348 }
 349
 350
 351 void InsetFloat::wide(bool w, BufferParams const & bp)
 352 {
 353         params_.wide = w;
 354
 355         string lab(_("float:"));
 356         lab += floatname(params_.type, bp);
 357
 358         if (params_.wide)
 359                 lab += '*';
 360
 361         setLabel(lab);
 362 }
 363
 364
 365 void InsetFloat::addToToc(toc::TocList & toclist, Buffer const * buf) const
 366 {
 367         ParIterator pit(inset.paragraphs.begin(), inset.paragraphs);
 368         ParIterator end(inset.paragraphs.end(), inset.paragraphs);
 369
 370         // Find a caption layout in one of the (child inset's) pars
 371         for (; pit != end; ++pit) {
 372                 if (pit->layout()->name() == caplayout) {
 373                         string const name = floatname(params_.type, buf->params);
 374                         string const str =
 375                                 tostr(toclist[name].size() + 1)
 376                                 + ". " + pit->asString(buf, false);
 377                         toc::TocItem const item(pit->id(), 0 , str);
 378                         toclist[name].push_back(item);
 379                 }
 380         }
 381 }
 382
 383
 384 string const InsetFloatMailer::name_("float");
 385
 386 InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
 387         : inset_(inset)
 388 {}
 389
 390
 391 string const InsetFloatMailer::inset2string() const
 392 {
 393         return params2string(inset_.params());
 394 }
 395
 396
 397 void InsetFloatMailer::string2params(string const & in,
 398                                      InsetFloatParams & params)
 399 {
 400         params = InsetFloatParams();
 401
 402         if (in.empty())
 403                 return;
 404
 405         istringstream data(STRCONV(in));
 406         LyXLex lex(0,0);
 407         lex.setStream(data);
 408
 409         if (lex.isOK()) {
 410                 lex.next();
 411                 string const token = lex.getString();
 412                 if (token != name_)
 413                         return;
 414         }
 415
 416         // This is part of the inset proper that is usually swallowed
 417         // by Buffer::readInset
 418         if (lex.isOK()) {
 419                 lex.next();
 420                 string const token = lex.getString();
 421                 if (token != "Float" || !lex.eatLine())
 422                         return;
 423         }
 424
 425         if (lex.isOK()) {
 426                 params.read(lex);
 427         }
 428 }
 429
 430
 431 string const InsetFloatMailer::params2string(InsetFloatParams const & params)
 432 {
 433         ostringstream data;
 434         data << name_ << ' ';
 435         params.write(data);
 436         return STRCONV(data.str());
 437 }