src/insets/InsetFloat.cpp

   1 /**
   2  * \file InsetFloat.cpp
   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  * \author Jürgen Spitzmüller
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "InsetFloat.h"
  16 #include "InsetCaption.h"
  17
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "BufferView.h"
  21 #include "Counters.h"
  22 #include "Cursor.h"
  23 #include "DispatchResult.h"
  24 #include "Floating.h"
  25 #include "FloatList.h"
  26 #include "FuncRequest.h"
  27 #include "FuncStatus.h"
  28 #include "LaTeXFeatures.h"
  29 #include "Lexer.h"
  30 #include "output_xhtml.h"
  31 #include "ParIterator.h"
  32 #include "TexRow.h"
  33 #include "texstream.h"
  34 #include "TextClass.h"
  35
  36 #include "support/debug.h"
  37 #include "support/docstream.h"
  38 #include "support/gettext.h"
  39 #include "support/lstrings.h"
  40
  41 #include "frontends/Application.h"
  42
  43 using namespace std;
  44 using namespace lyx::support;
  45
  46
  47 namespace lyx {
  48
  49 // With this inset it will be possible to support the latex package
  50 // float.sty, and I am sure that with this and some additional support
  51 // classes we can support similar functionality in other formats
  52 // (read DocBook).
  53 // By using float.sty we will have the same handling for all floats, both
  54 // for those already in existance (table and figure) and all user created
  55 // ones¹. So suddenly we give the users the possibility of creating new
  56 // kinds of floats on the fly. (and with a uniform look)
  57 //
  58 // API to float.sty:
  59 //   \newfloat{type}{placement}{ext}[within]
  60 //     type      - The "type" of the new class of floats, like program or
  61 //                 algorithm. After the appropriate \newfloat, commands
  62 //                 such as \begin{program} or \end{algorithm*} will be
  63 //                 available.
  64 //     placement - The default placement for the given class of floats.
  65 //                 They are like in standard LaTeX: t, b, p and h for top,
  66 //                 bottom, page, and here, respectively. On top of that
  67 //                 there is a new type, H, which does not really correspond
  68 //                 to a float, since it means: put it "here" and nowhere else.
  69 //                 Note, however that the H specifier is special and, because
  70 //                 of implementation details cannot be used in the second
  71 //                 argument of \newfloat.
  72 //     ext       - The file name extension of an auxiliary file for the list
  73 //                 of figures (or whatever). LaTeX writes the captions to
  74 //                 this file.
  75 //     within    - This (optional) argument determines whether floats of this
  76 //                 class will be numbered within some sectional unit of the
  77 //                 document. For example, if within is equal to chapter, the
  78 //                 floats will be numbered within chapters.
  79 //   \floatstyle{style}
  80 //     style -  plain, boxed, ruled
  81 //   \floatname{float}{floatname}
  82 //     float     -
  83 //     floatname -
  84 //   \floatplacement{float}{placement}
  85 //     float     -
  86 //     placement -
  87 //   \restylefloat{float}
  88 //     float -
  89 //   \listof{type}{title}
  90 //     title -
  91
  92 // ¹ the algorithm float is defined using the float.sty package. Like this
  93 //   \floatstyle{ruled}
  94 //   \newfloat{algorithm}{htbp}{loa}[<sect>]
  95 //   \floatname{algorithm}{Algorithm}
  96 //
  97 // The intention is that floats should be definable from two places:
  98 //          - layout files
  99 //          - the "gui" (i.e. by the user)
 100 //
 101 // From layout files.
 102 // This should only be done for floats defined in a documentclass and that
 103 // does not need any additional packages. The two most known floats in this
 104 // category is "table" and "figure". Floats defined in layout files are only
 105 // stored in lyx files if the user modifies them.
 106 //
 107 // By the user.
 108 // There should be a gui dialog (and also a collection of lyxfuncs) where
 109 // the user can modify existing floats and/or create new ones.
 110 //
 111 // The individual floats will also have some settable
 112 // variables: wide and placement.
 113 //
 114 // Lgb
 115
 116 //FIXME: why do we set in stone the type here?
 117 InsetFloat::InsetFloat(Buffer * buf, string params_str)
 118         : InsetCaptionable(buf)
 119 {
 120         string2params(params_str, params_);
 121         setCaptionType(params_.type);
 122 }
 123
 124
 125 // Enforce equality of float type and caption type.
 126 void InsetFloat::setCaptionType(std::string const & type)
 127 {
 128         InsetCaptionable::setCaptionType(type);
 129         params_.type = captionType();
 130         // check if the float type exists
 131         if (buffer().params().documentClass().floats().typeExist(params_.type))
 132                 setLabel(_("float: ") + floatName(params_.type));
 133         else
 134                 setLabel(bformat(_("ERROR: Unknown float type: %1$s"), from_utf8(params_.type)));
 135 }
 136
 137
 138 docstring InsetFloat::layoutName() const
 139 {
 140         return "Float:" + from_utf8(params_.type);
 141 }
 142
 143
 144 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 145 {
 146         if (isOpen(bv))
 147                 return InsetCaptionable::toolTip(bv, x, y);
 148
 149         OutputParams rp(&buffer().params().encoding());
 150         return getCaptionText(rp);
 151 }
 152
 153
 154 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 155 {
 156         switch (cmd.action()) {
 157
 158         case LFUN_INSET_MODIFY: {
 159                 InsetFloatParams params;
 160                 string2params(to_utf8(cmd.argument()), params);
 161                 cur.recordUndoInset(this);
 162
 163                 // placement, wide and sideways are not used for subfloats
 164                 if (!params_.subfloat) {
 165                         params_.placement = params.placement;
 166                         params_.wide      = params.wide;
 167                         params_.sideways  = params.sideways;
 168                 }
 169                 setNewLabel();
 170                 if (params_.type != params.type)
 171                         setCaptionType(params.type);
 172                 // what we really want here is a TOC update, but that means
 173                 // a full buffer update
 174                 cur.forceBufferUpdate();
 175                 break;
 176         }
 177
 178         case LFUN_INSET_DIALOG_UPDATE: {
 179                 cur.bv().updateDialog("float", params2string(params()));
 180                 break;
 181         }
 182
 183         default:
 184                 InsetCaptionable::doDispatch(cur, cmd);
 185                 break;
 186         }
 187 }
 188
 189
 190 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
 191                 FuncStatus & flag) const
 192 {
 193         switch (cmd.action()) {
 194
 195         case LFUN_INSET_MODIFY:
 196         case LFUN_INSET_DIALOG_UPDATE:
 197                 flag.setEnabled(true);
 198                 return true;
 199
 200         case LFUN_INSET_SETTINGS:
 201                 if (InsetCaptionable::getStatus(cur, cmd, flag)) {
 202                         flag.setEnabled(flag.enabled() && !params_.subfloat);
 203                         return true;
 204                 } else
 205                         return false;
 206
 207         case LFUN_NEWLINE_INSERT:
 208                 if (params_.subfloat) {
 209                         flag.setEnabled(false);
 210                         return true;
 211                 }
 212
 213         default:
 214                 return InsetCaptionable::getStatus(cur, cmd, flag);
 215         }
 216 }
 217
 218
 219 bool InsetFloat::hasSubCaptions(ParIterator const & it) const
 220 {
 221         return (it.innerInsetOfType(FLOAT_CODE) || it.innerInsetOfType(WRAP_CODE));
 222 }
 223
 224
 225 void InsetFloatParams::write(ostream & os) const
 226 {
 227         if (type.empty()) {
 228                 // Better this than creating a parse error. This in fact happens in the
 229                 // parameters dialog via InsetFloatParams::params2string.
 230                 os << "senseless" << '\n';
 231         } else
 232                 os << type << '\n';
 233
 234         if (!placement.empty())
 235                 os << "placement " << placement << "\n";
 236
 237         if (wide)
 238                 os << "wide true\n";
 239         else
 240                 os << "wide false\n";
 241
 242         if (sideways)
 243                 os << "sideways true\n";
 244         else
 245                 os << "sideways false\n";
 246 }
 247
 248
 249 void InsetFloatParams::read(Lexer & lex)
 250 {
 251         lex.setContext("InsetFloatParams::read");
 252         lex >> type;
 253         if (lex.checkFor("placement"))
 254                 lex >> placement;
 255         lex >> "wide" >> wide;
 256         lex >> "sideways" >> sideways;
 257 }
 258
 259
 260 void InsetFloat::write(ostream & os) const
 261 {
 262         os << "Float ";
 263         params_.write(os);
 264         InsetCaptionable::write(os);
 265 }
 266
 267
 268 void InsetFloat::read(Lexer & lex)
 269 {
 270         params_.read(lex);
 271         InsetCaptionable::read(lex);
 272         setCaptionType(params_.type);
 273 }
 274
 275
 276 void InsetFloat::validate(LaTeXFeatures & features) const
 277 {
 278         if (support::contains(params_.placement, 'H'))
 279                 features.require("float");
 280
 281         if (params_.sideways)
 282                 features.require("rotfloat");
 283
 284         if (features.inFloat())
 285                 features.require("subfig");
 286
 287         features.useFloat(params_.type, features.inFloat());
 288         features.inFloat(true);
 289         InsetCaptionable::validate(features);
 290         features.inFloat(false);
 291 }
 292
 293
 294 docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 295 {
 296         FloatList const & floats = buffer().params().documentClass().floats();
 297         Floating const & ftype = floats.getType(params_.type);
 298         string const & htmltype = ftype.htmlTag();
 299         string const & attr = ftype.htmlAttrib();
 300
 301         odocstringstream ods;
 302         XHTMLStream newxs(ods);
 303         newxs << html::StartTag(htmltype, attr);
 304         InsetText::XHTMLOptions const opts =
 305                 InsetText::WriteLabel | InsetText::WriteInnerTag;
 306         docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
 307         newxs << html::EndTag(htmltype);
 308
 309         if (rp.inFloat == OutputParams::NONFLOAT) {
 310                 // In this case, this float needs to be deferred, but we'll put it
 311                 // before anything the text itself deferred.
 312                 deferred = ods.str() + '\n' + deferred;
 313         } else {
 314                 // In this case, the whole thing is already being deferred, so
 315                 // we can write to the stream.
 316                 // Note that things will already have been escaped, so we do not
 317                 // want to escape them again.
 318                 xs << XHTMLStream::ESCAPE_NONE << ods.str();
 319         }
 320         return deferred;
 321 }
 322
 323
 324 void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
 325 {
 326         if (runparams_in.inFloat != OutputParams::NONFLOAT) {
 327                 if (!paragraphs().empty() && !runparams_in.nice)
 328                         // improve TexRow precision in non-nice mode
 329                         os << safebreakln;
 330
 331                 if (runparams_in.moving_arg)
 332                         os << "\\protect";
 333                 os << "\\subfloat";
 334
 335                 OutputParams rp = runparams_in;
 336                 rp.moving_arg = true;
 337                 os << getCaption(rp);
 338                 os << '{';
 339                 // The main argument is the contents of the float. This is not a moving argument.
 340                 rp.moving_arg = false;
 341                 rp.inFloat = OutputParams::SUBFLOAT;
 342                 InsetText::latex(os, rp);
 343                 os << "}";
 344
 345                 return;
 346         }
 347         OutputParams runparams(runparams_in);
 348         runparams.inFloat = OutputParams::MAINFLOAT;
 349
 350         FloatList const & floats = buffer().params().documentClass().floats();
 351         string tmptype = params_.type;
 352         if (params_.sideways && floats.allowsSideways(params_.type))
 353                 tmptype = "sideways" + params_.type;
 354         if (params_.wide && floats.allowsWide(params_.type)
 355                 && (!params_.sideways ||
 356                      params_.type == "figure" ||
 357                      params_.type == "table"))
 358                 tmptype += "*";
 359         // Figure out the float placement to use.
 360         // From lowest to highest:
 361         // - float default placement
 362         // - document wide default placement
 363         // - specific float placement
 364         string tmpplacement;
 365         string const buf_placement = buffer().params().float_placement;
 366         string const def_placement = floats.defaultPlacement(params_.type);
 367         if (!params_.placement.empty()
 368             && params_.placement != def_placement) {
 369                 tmpplacement = params_.placement;
 370         } else if (params_.placement.empty()
 371                    && !buf_placement.empty()
 372                    && buf_placement != def_placement) {
 373                 tmpplacement = buf_placement;
 374         }
 375
 376         // Check if placement is allowed by this float
 377         string const allowed_placement =
 378                 floats.allowedPlacement(params_.type);
 379         string placement;
 380         string::const_iterator lit = tmpplacement.begin();
 381         string::const_iterator end = tmpplacement.end();
 382         for (; lit != end; ++lit) {
 383                 if (contains(allowed_placement, *lit))
 384                         placement += *lit;
 385         }
 386
 387         // Force \begin{<floatname>} to appear in a new line.
 388         os << breakln << "\\begin{" << from_ascii(tmptype) << '}';
 389         if (runparams.lastid != -1)
 390                 os.texrow().start(runparams.lastid, runparams.lastpos);
 391         // We only output placement if different from the def_placement.
 392         // sidewaysfloats always use their own page
 393         if (!placement.empty() && !params_.sideways)
 394                 os << '[' << from_ascii(placement) << ']';
 395         os << '\n';
 396
 397         InsetText::latex(os, runparams);
 398
 399         // Force \end{<floatname>} to appear in a new line.
 400         os << breakln << "\\end{" << from_ascii(tmptype) << "}\n";
 401 }
 402
 403
 404 int InsetFloat::plaintext(odocstringstream & os, OutputParams const & runparams, size_t max_length) const
 405 {
 406         os << '[' << buffer().B_("float") << ' '
 407                 << floatName(params_.type) << ":\n";
 408         InsetText::plaintext(os, runparams, max_length);
 409         os << "\n]";
 410
 411         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 412 }
 413
 414
 415 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
 416 {
 417         // FIXME Implement subfloat!
 418         // FIXME UNICODE
 419         os << '<' << from_ascii(params_.type) << '>';
 420         int const i = InsetText::docbook(os, runparams);
 421         os << "</" << from_ascii(params_.type) << '>';
 422
 423         return i;
 424 }
 425
 426
 427 bool InsetFloat::insetAllowed(InsetCode code) const
 428 {
 429         // The case that code == FLOAT_CODE is handled in Text3.cpp,
 430         // because we need to know what type of float is meant.
 431         switch(code) {
 432         case WRAP_CODE:
 433         case FOOT_CODE:
 434         case MARGIN_CODE:
 435                 return false;
 436         default:
 437                 return InsetCaptionable::insetAllowed(code);
 438         }
 439 }
 440
 441
 442 void InsetFloat::setWide(bool w, bool update_label)
 443 {
 444         if (!buffer().params().documentClass().floats().allowsWide(params_.type))
 445                 params_.wide = false;
 446         else
 447             params_.wide = w;
 448         if (update_label)
 449                 setNewLabel();
 450 }
 451
 452
 453 void InsetFloat::setSideways(bool s, bool update_label)
 454 {
 455         if (!buffer().params().documentClass().floats().allowsSideways(params_.type))
 456                 params_.sideways = false;
 457         else
 458                 params_.sideways = s;
 459         if (update_label)
 460                 setNewLabel();
 461 }
 462
 463
 464 void InsetFloat::setSubfloat(bool s, bool update_label)
 465 {
 466         params_.subfloat = s;
 467         if (update_label)
 468                 setNewLabel();
 469 }
 470
 471
 472 void InsetFloat::setNewLabel()
 473 {
 474         docstring lab = _("float: ");
 475
 476         if (params_.subfloat)
 477                 lab = _("subfloat: ");
 478
 479         lab += floatName(params_.type);
 480
 481         FloatList const & floats = buffer().params().documentClass().floats();
 482
 483         if (params_.wide && floats.allowsWide(params_.type))
 484                 lab += '*';
 485
 486         if (params_.sideways && floats.allowsSideways(params_.type))
 487                 lab += _(" (sideways)");
 488
 489         setLabel(lab);
 490 }
 491
 492
 493 bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
 494 {
 495         return !params_.subfloat && newtype != "Unnumbered";
 496 }
 497
 498
 499 TexString InsetFloat::getCaption(OutputParams const & runparams) const
 500 {
 501         InsetCaption const * ins = getCaptionInset();
 502         if (ins == 0)
 503                 return TexString();
 504
 505         otexstringstream os;
 506         ins->getArgs(os, runparams);
 507
 508         if (!runparams.nice)
 509                 // increase TexRow precision in non-nice mode
 510                 os << safebreakln;
 511         os << '[';
 512         otexstringstream os2;
 513         ins->getArgument(os2, runparams);
 514         TexString ts = os2.release();
 515         docstring & arg = ts.str;
 516         // Protect ']'
 517         if (arg.find(']') != docstring::npos)
 518                 arg = '{' + arg + '}';
 519         os << move(ts);
 520         os << ']';
 521         if (!runparams.nice)
 522                 os << safebreakln;
 523         return os.release();
 524 }
 525
 526
 527 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 528 {
 529         params = InsetFloatParams();
 530         if (in.empty())
 531                 return;
 532
 533         istringstream data(in);
 534         Lexer lex;
 535         lex.setStream(data);
 536         lex.setContext("InsetFloat::string2params");
 537         params.read(lex);
 538 }
 539
 540
 541 string InsetFloat::params2string(InsetFloatParams const & params)
 542 {
 543         ostringstream data;
 544         params.write(data);
 545         return data.str();
 546 }
 547
 548
 549 } // namespace lyx