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                 setNewLabel();
 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                 params_.alignment  = params.alignment;
 170                 setNewLabel();
 171                 if (params_.type != params.type)
 172                         setCaptionType(params.type);
 173                 // what we really want here is a TOC update, but that means
 174                 // a full buffer update
 175                 cur.forceBufferUpdate();
 176                 break;
 177         }
 178
 179         case LFUN_INSET_DIALOG_UPDATE: {
 180                 cur.bv().updateDialog("float", params2string(params()));
 181                 break;
 182         }
 183
 184         default:
 185                 InsetCaptionable::doDispatch(cur, cmd);
 186                 break;
 187         }
 188 }
 189
 190
 191 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
 192                 FuncStatus & flag) const
 193 {
 194         switch (cmd.action()) {
 195
 196         case LFUN_INSET_MODIFY:
 197         case LFUN_INSET_DIALOG_UPDATE:
 198                 flag.setEnabled(true);
 199                 return true;
 200
 201         case LFUN_INSET_SETTINGS:
 202                 if (InsetCaptionable::getStatus(cur, cmd, flag)) {
 203                         flag.setEnabled(flag.enabled() && !params_.subfloat);
 204                         return true;
 205                 } else
 206                         return false;
 207
 208         case LFUN_NEWLINE_INSERT:
 209                 if (params_.subfloat) {
 210                         flag.setEnabled(false);
 211                         return true;
 212                 }
 213                 // no subfloat:
 214                 // fall through
 215
 216         default:
 217                 return InsetCaptionable::getStatus(cur, cmd, flag);
 218         }
 219 }
 220
 221
 222 bool InsetFloat::hasSubCaptions(ParIterator const & it) const
 223 {
 224         return (it.innerInsetOfType(FLOAT_CODE) || it.innerInsetOfType(WRAP_CODE));
 225 }
 226
 227
 228 void InsetFloatParams::write(ostream & os) const
 229 {
 230         if (type.empty()) {
 231                 // Better this than creating a parse error. This in fact happens in the
 232                 // parameters dialog via InsetFloatParams::params2string.
 233                 os << "senseless" << '\n';
 234         } else
 235                 os << type << '\n';
 236
 237         if (!placement.empty())
 238                 os << "placement " << placement << "\n";
 239         if (!alignment.empty())
 240                 os << "alignment " << alignment << "\n";
 241
 242         if (wide)
 243                 os << "wide true\n";
 244         else
 245                 os << "wide false\n";
 246
 247         if (sideways)
 248                 os << "sideways true\n";
 249         else
 250                 os << "sideways false\n";
 251 }
 252
 253
 254 void InsetFloatParams::read(Lexer & lex)
 255 {
 256         lex.setContext("InsetFloatParams::read");
 257         lex >> type;
 258         if (lex.checkFor("placement"))
 259                 lex >> placement;
 260         if (lex.checkFor("alignment"))
 261                 lex >> alignment;
 262         lex >> "wide" >> wide;
 263         lex >> "sideways" >> sideways;
 264 }
 265
 266
 267 void InsetFloat::write(ostream & os) const
 268 {
 269         os << "Float ";
 270         params_.write(os);
 271         InsetCaptionable::write(os);
 272 }
 273
 274
 275 void InsetFloat::read(Lexer & lex)
 276 {
 277         params_.read(lex);
 278         InsetCaptionable::read(lex);
 279         setCaptionType(params_.type);
 280 }
 281
 282
 283 void InsetFloat::validate(LaTeXFeatures & features) const
 284 {
 285         if (support::contains(params_.placement, 'H'))
 286                 features.require("float");
 287
 288         if (params_.sideways)
 289                 features.require("rotfloat");
 290
 291         if (features.inFloat())
 292                 features.require("subfig");
 293
 294         features.useFloat(params_.type, features.inFloat());
 295         features.inFloat(true);
 296         InsetCaptionable::validate(features);
 297         features.inFloat(false);
 298 }
 299
 300
 301 docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 302 {
 303         FloatList const & floats = buffer().params().documentClass().floats();
 304         Floating const & ftype = floats.getType(params_.type);
 305         string const & htmltype = ftype.htmlTag();
 306         string const & attr = ftype.htmlAttrib();
 307
 308         odocstringstream ods;
 309         XHTMLStream newxs(ods);
 310         newxs << html::StartTag(htmltype, attr);
 311         InsetText::XHTMLOptions const opts =
 312                 InsetText::WriteLabel | InsetText::WriteInnerTag;
 313         docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
 314         newxs << html::EndTag(htmltype);
 315
 316         if (rp.inFloat == OutputParams::NONFLOAT) {
 317                 // In this case, this float needs to be deferred, but we'll put it
 318                 // before anything the text itself deferred.
 319                 deferred = ods.str() + '\n' + deferred;
 320         } else {
 321                 // In this case, the whole thing is already being deferred, so
 322                 // we can write to the stream.
 323                 // Note that things will already have been escaped, so we do not
 324                 // want to escape them again.
 325                 xs << XHTMLStream::ESCAPE_NONE << ods.str();
 326         }
 327         return deferred;
 328 }
 329
 330
 331 void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
 332 {
 333         if (runparams_in.inFloat != OutputParams::NONFLOAT) {
 334                 if (!paragraphs().empty() && !runparams_in.nice)
 335                         // improve TexRow precision in non-nice mode
 336                         os << safebreakln;
 337
 338                 if (runparams_in.moving_arg)
 339                         os << "\\protect";
 340                 os << "\\subfloat";
 341
 342                 OutputParams rp = runparams_in;
 343                 rp.moving_arg = true;
 344                 os << getCaption(rp);
 345                 os << '{';
 346                 // The main argument is the contents of the float. This is not a moving argument.
 347                 rp.moving_arg = false;
 348                 rp.inFloat = OutputParams::SUBFLOAT;
 349                 InsetText::latex(os, rp);
 350                 os << "}";
 351
 352                 return;
 353         }
 354         OutputParams runparams(runparams_in);
 355         runparams.inFloat = OutputParams::MAINFLOAT;
 356
 357         FloatList const & floats = buffer().params().documentClass().floats();
 358         string tmptype = params_.type;
 359         if (params_.sideways && floats.allowsSideways(params_.type))
 360                 tmptype = "sideways" + params_.type;
 361         if (params_.wide && floats.allowsWide(params_.type)
 362                 && (!params_.sideways ||
 363                      params_.type == "figure" ||
 364                      params_.type == "table"))
 365                 tmptype += "*";
 366         // Figure out the float placement to use.
 367         // From lowest to highest:
 368         // - float default placement
 369         // - document wide default placement
 370         // - specific float placement
 371         string tmpplacement;
 372         string const buf_placement = buffer().params().float_placement;
 373         string const def_placement = floats.defaultPlacement(params_.type);
 374         if (params_.placement == "document"
 375             && !buf_placement.empty()
 376             && buf_placement != def_placement) {
 377                 tmpplacement = buf_placement;
 378         } else if (!params_.placement.empty()
 379                    && params_.placement != "document"
 380                    && params_.placement != def_placement) {
 381                 tmpplacement = params_.placement;
 382         }
 383
 384         // Check if placement is allowed by this float
 385         string const allowed_placement =
 386                 floats.allowedPlacement(params_.type);
 387         string placement;
 388         string::const_iterator lit = tmpplacement.begin();
 389         string::const_iterator end = tmpplacement.end();
 390         for (; lit != end; ++lit) {
 391                 if (contains(allowed_placement, *lit))
 392                         placement += *lit;
 393         }
 394
 395         string alignment;
 396         string const buf_alignment = buffer().params().float_alignment;
 397         if (params_.alignment == "document"
 398             && !buf_alignment.empty()) {
 399                 alignment = buf_alignment;
 400         } else if (!params_.alignment.empty()
 401                    && params_.alignment != "class"
 402                    && params_.alignment != "document") {
 403                 alignment = params_.alignment;
 404         }
 405
 406         // Force \begin{<floatname>} to appear in a new line.
 407         os << breakln << "\\begin{" << from_ascii(tmptype) << '}';
 408         if (runparams.lastid != -1)
 409                 os.texrow().start(runparams.lastid, runparams.lastpos);
 410         // We only output placement if different from the def_placement.
 411         // sidewaysfloats always use their own page,
 412         // therefore don't output the p option that is always set
 413         if (!placement.empty()
 414             && (!params_.sideways || (params_.sideways && from_ascii(placement) != "p")))
 415                 os << '[' << from_ascii(placement) << ']';
 416         os << '\n';
 417         if (alignment == "left")
 418                 os << "\\raggedright" << breakln;
 419         else if (alignment == "center")
 420                 os << "\\centering" << breakln;
 421         else if (alignment == "right")
 422                 os << "\\raggedleft" << breakln;
 423
 424         InsetText::latex(os, runparams);
 425
 426         // Force \end{<floatname>} to appear in a new line.
 427         os << breakln << "\\end{" << from_ascii(tmptype) << "}\n";
 428 }
 429
 430
 431 int InsetFloat::plaintext(odocstringstream & os, OutputParams const & runparams, size_t max_length) const
 432 {
 433         os << '[' << buffer().B_("float") << ' '
 434                 << floatName(params_.type) << ":\n";
 435         InsetText::plaintext(os, runparams, max_length);
 436         os << "\n]";
 437
 438         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 439 }
 440
 441
 442 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
 443 {
 444         // FIXME Implement subfloat!
 445         // FIXME UNICODE
 446         os << '<' << from_ascii(params_.type) << '>';
 447         int const i = InsetText::docbook(os, runparams);
 448         os << "</" << from_ascii(params_.type) << '>';
 449
 450         return i;
 451 }
 452
 453
 454 bool InsetFloat::insetAllowed(InsetCode code) const
 455 {
 456         // The case that code == FLOAT_CODE is handled in Text3.cpp,
 457         // because we need to know what type of float is meant.
 458         switch(code) {
 459         case WRAP_CODE:
 460         case FOOT_CODE:
 461         case MARGIN_CODE:
 462                 return false;
 463         default:
 464                 return InsetCaptionable::insetAllowed(code);
 465         }
 466 }
 467
 468
 469 void InsetFloat::setWide(bool w, bool update_label)
 470 {
 471         if (!buffer().params().documentClass().floats().allowsWide(params_.type))
 472                 params_.wide = false;
 473         else
 474             params_.wide = w;
 475         if (update_label)
 476                 setNewLabel();
 477 }
 478
 479
 480 void InsetFloat::setSideways(bool s, bool update_label)
 481 {
 482         if (!buffer().params().documentClass().floats().allowsSideways(params_.type))
 483                 params_.sideways = false;
 484         else
 485                 params_.sideways = s;
 486         if (update_label)
 487                 setNewLabel();
 488 }
 489
 490
 491 void InsetFloat::setSubfloat(bool s, bool update_label)
 492 {
 493         params_.subfloat = s;
 494         if (update_label)
 495                 setNewLabel();
 496 }
 497
 498
 499 void InsetFloat::setNewLabel()
 500 {
 501         docstring lab = _("float: ");
 502
 503         if (params_.subfloat)
 504                 lab = _("subfloat: ");
 505
 506         lab += floatName(params_.type);
 507
 508         FloatList const & floats = buffer().params().documentClass().floats();
 509
 510         if (params_.wide && floats.allowsWide(params_.type))
 511                 lab += '*';
 512
 513         if (params_.sideways && floats.allowsSideways(params_.type))
 514                 lab += _(" (sideways)");
 515
 516         setLabel(lab);
 517 }
 518
 519
 520 bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
 521 {
 522         return !params_.subfloat && newtype != "Unnumbered";
 523 }
 524
 525
 526 TexString InsetFloat::getCaption(OutputParams const & runparams) const
 527 {
 528         InsetCaption const * ins = getCaptionInset();
 529         if (ins == 0)
 530                 return TexString();
 531
 532         otexstringstream os;
 533         ins->getArgs(os, runparams);
 534
 535         if (!runparams.nice)
 536                 // increase TexRow precision in non-nice mode
 537                 os << safebreakln;
 538         os << '[';
 539         otexstringstream os2;
 540         ins->getArgument(os2, runparams);
 541         TexString ts = os2.release();
 542         docstring & arg = ts.str;
 543         // Protect ']'
 544         if (arg.find(']') != docstring::npos)
 545                 arg = '{' + arg + '}';
 546         os << move(ts);
 547         os << ']';
 548         if (!runparams.nice)
 549                 os << safebreakln;
 550         return os.release();
 551 }
 552
 553
 554 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 555 {
 556         params = InsetFloatParams();
 557         if (in.empty())
 558                 return;
 559
 560         istringstream data(in);
 561         Lexer lex;
 562         lex.setStream(data);
 563         lex.setContext("InsetFloat::string2params");
 564         params.read(lex);
 565 }
 566
 567
 568 string InsetFloat::params2string(InsetFloatParams const & params)
 569 {
 570         ostringstream data;
 571         params.write(data);
 572         return data.str();
 573 }
 574
 575
 576 } // namespace lyx