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 "ParIterator.h"
  31 #include "TextClass.h"
  32
  33 #include "support/debug.h"
  34 #include "support/docstream.h"
  35 #include "support/gettext.h"
  36 #include "support/lstrings.h"
  37
  38 #include "frontends/Application.h"
  39
  40 using namespace std;
  41
  42
  43 namespace lyx {
  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
 113 InsetFloat::InsetFloat(Buffer * buf, string const & type)
 114         : InsetCollapsable(buf), name_(from_utf8(type))
 115 {
 116         setLabel(_("float: ") + floatName(type));
 117         params_.type = type;
 118 }
 119
 120
 121 InsetFloat::~InsetFloat()
 122 {
 123         hideDialogs("float", this);
 124 }
 125
 126
 127 docstring InsetFloat::name() const
 128 {
 129         return "Float:" + name_;
 130 }
 131
 132
 133 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 134 {
 135         if (InsetCollapsable::toolTip(bv, x, y).empty() || isOpen(bv))
 136                 return docstring();
 137
 138         OutputParams rp(&buffer().params().encoding());
 139         return getCaptionText(rp);
 140 }
 141
 142
 143 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 144 {
 145         switch (cmd.action) {
 146
 147         case LFUN_INSET_MODIFY: {
 148                 InsetFloatParams params;
 149                 string2params(to_utf8(cmd.argument()), params);
 150
 151                 // placement, wide and sideways are not used for subfloats
 152                 if (!params_.subfloat) {
 153                         params_.placement = params.placement;
 154                         params_.wide      = params.wide;
 155                         params_.sideways  = params.sideways;
 156                 }
 157
 158                 setNewLabel();
 159                 break;
 160         }
 161
 162         case LFUN_INSET_DIALOG_UPDATE: {
 163                 cur.bv().updateDialog("float", params2string(params()));
 164                 break;
 165         }
 166
 167         default:
 168                 InsetCollapsable::doDispatch(cur, cmd);
 169                 break;
 170         }
 171 }
 172
 173
 174 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
 175                 FuncStatus & flag) const
 176 {
 177         switch (cmd.action) {
 178
 179         case LFUN_INSET_MODIFY:
 180         case LFUN_INSET_DIALOG_UPDATE:
 181                 flag.setEnabled(true);
 182                 return true;
 183
 184         case LFUN_INSET_SETTINGS:
 185                 if (InsetCollapsable::getStatus(cur, cmd, flag)) {
 186                         flag.setEnabled(flag.enabled() && !params_.subfloat);
 187                         return true;
 188                 } else
 189                         return false;
 190
 191         default:
 192                 return InsetCollapsable::getStatus(cur, cmd, flag);
 193         }
 194 }
 195
 196
 197 void InsetFloat::updateLabels(ParIterator const & it)
 198 {
 199         Counters & cnts =
 200                 buffer().masterBuffer()->params().documentClass().counters();
 201         string const saveflt = cnts.current_float();
 202         bool const savesubflt = cnts.isSubfloat();
 203
 204         bool const subflt = (it.innerInsetOfType(FLOAT_CODE)
 205                              || it.innerInsetOfType(WRAP_CODE));
 206         // floats can only embed subfloats of their own kind
 207         if (subflt)
 208                 params_.type = saveflt;
 209         setSubfloat(subflt);
 210
 211         // Tell to captions what the current float is
 212         cnts.current_float(params().type);
 213         cnts.isSubfloat(subflt);
 214
 215         InsetCollapsable::updateLabels(it);
 216
 217         //reset afterwards
 218         cnts.current_float(saveflt);
 219         cnts.isSubfloat(savesubflt);
 220 }
 221
 222
 223 void InsetFloatParams::write(ostream & os) const
 224 {
 225         os << "Float " << type << '\n';
 226
 227         if (!placement.empty())
 228                 os << "placement " << placement << "\n";
 229
 230         if (wide)
 231                 os << "wide true\n";
 232         else
 233                 os << "wide false\n";
 234
 235         if (sideways)
 236                 os << "sideways true\n";
 237         else
 238                 os << "sideways false\n";
 239 }
 240
 241
 242 void InsetFloatParams::read(Lexer & lex)
 243 {
 244         lex.setContext("InsetFloatParams::read");
 245         if (lex.checkFor("placement"))
 246                 lex >> placement;
 247         lex >> "wide" >> wide;
 248         lex >> "sideways" >> sideways;
 249 }
 250
 251
 252 void InsetFloat::write(ostream & os) const
 253 {
 254         params_.write(os);
 255         InsetCollapsable::write(os);
 256 }
 257
 258
 259 void InsetFloat::read(Lexer & lex)
 260 {
 261         params_.read(lex);
 262         InsetCollapsable::read(lex);
 263 }
 264
 265
 266 void InsetFloat::validate(LaTeXFeatures & features) const
 267 {
 268         if (support::contains(params_.placement, 'H'))
 269                 features.require("float");
 270
 271         if (params_.sideways)
 272                 features.require("rotfloat");
 273
 274         if (features.inFloat())
 275                 features.require("subfig");
 276
 277         features.useFloat(params_.type, features.inFloat());
 278         features.inFloat(true);
 279         InsetCollapsable::validate(features);
 280         features.inFloat(false);
 281 }
 282
 283
 284 docstring InsetFloat::xhtml(odocstream & os, OutputParams const & rp) const
 285 {
 286         FloatList const & floats = buffer().params().documentClass().floats();
 287         Floating const & ftype = floats.getType(params_.type);
 288         string const htmltype = ftype.htmlType().empty() ?
 289                         "div" : ftype.htmlType();
 290         string const htmlclass = ftype.htmlClass().empty() ?
 291                         "float-" + params_.type : ftype.htmlClass();
 292         docstring const otag =
 293                         from_ascii("<" + htmltype + " class='float " + htmlclass + "'>\n");
 294         docstring const ctag = from_ascii("</" + htmltype + ">\n");
 295
 296         odocstringstream out;
 297
 298         out << otag;
 299         docstring def = InsetText::xhtml(out, rp);
 300         out << ctag;
 301
 302         if (rp.inFloat == OutputParams::NONFLOAT)
 303                 // In this case, this float needs to be deferred, but we'll put it
 304                 // before anything the text itself deferred.
 305                 def = out.str() + '\n' + def;
 306         else
 307                 // In this case, the whole thing is already being deferred, so
 308                 // we can write to the stream.
 309                 os << out.str();
 310         return def;
 311 }
 312
 313
 314 int InsetFloat::latex(odocstream & os, OutputParams const & runparams_in) const
 315 {
 316         if (runparams_in.inFloat != OutputParams::NONFLOAT) {
 317                 if (runparams_in.moving_arg)
 318                         os << "\\protect";
 319                 os << "\\subfloat";
 320
 321                 OutputParams rp = runparams_in;
 322                 docstring const caption = getCaption(rp);
 323                 if (!caption.empty()) {
 324                         os << caption;
 325                 }
 326                 os << '{';
 327                 rp.inFloat = OutputParams::SUBFLOAT;
 328                 int const i = InsetText::latex(os, rp);
 329                 os << "}";
 330
 331                 return i + 1;
 332         }
 333         OutputParams runparams(runparams_in);
 334         runparams.inFloat = OutputParams::MAINFLOAT;
 335
 336         FloatList const & floats = buffer().params().documentClass().floats();
 337         string tmptype = params_.type;
 338         if (params_.sideways)
 339                 tmptype = "sideways" + params_.type;
 340         if (params_.wide && (!params_.sideways ||
 341                              params_.type == "figure" ||
 342                              params_.type == "table"))
 343                 tmptype += "*";
 344         // Figure out the float placement to use.
 345         // From lowest to highest:
 346         // - float default placement
 347         // - document wide default placement
 348         // - specific float placement
 349         string placement;
 350         string const buf_placement = buffer().params().float_placement;
 351         string const def_placement = floats.defaultPlacement(params_.type);
 352         if (!params_.placement.empty()
 353             && params_.placement != def_placement) {
 354                 placement = params_.placement;
 355         } else if (params_.placement.empty()
 356                    && !buf_placement.empty()
 357                    && buf_placement != def_placement) {
 358                 placement = buf_placement;
 359         }
 360
 361         // The \n is used to force \begin{<floatname>} to appear in a new line.
 362         // The % is needed to prevent two consecutive \n chars in the case
 363         // when the current output line is empty.
 364         os << "%\n\\begin{" << from_ascii(tmptype) << '}';
 365         // We only output placement if different from the def_placement.
 366         // sidewaysfloats always use their own page
 367         if (!placement.empty() && !params_.sideways) {
 368                 os << '[' << from_ascii(placement) << ']';
 369         }
 370         os << '\n';
 371
 372         int const i = InsetText::latex(os, runparams);
 373
 374         // The \n is used to force \end{<floatname>} to appear in a new line.
 375         // In this case, we do not case if the current output line is empty.
 376         os << "\n\\end{" << from_ascii(tmptype) << "}\n";
 377
 378         return i + 4;
 379 }
 380
 381
 382 int InsetFloat::plaintext(odocstream & os, OutputParams const & runparams) const
 383 {
 384         os << '[' << buffer().B_("float") << ' '
 385                 << floatName(params_.type) << ":\n";
 386         InsetText::plaintext(os, runparams);
 387         os << "\n]";
 388
 389         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 390 }
 391
 392
 393 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
 394 {
 395         // FIXME Implement subfloat!
 396         // FIXME UNICODE
 397         os << '<' << from_ascii(params_.type) << '>';
 398         int const i = InsetText::docbook(os, runparams);
 399         os << "</" << from_ascii(params_.type) << '>';
 400
 401         return i;
 402 }
 403
 404
 405 bool InsetFloat::insetAllowed(InsetCode code) const
 406 {
 407         // The case that code == FLOAT_CODE is handled in Text3.cpp,
 408         // because we need to know what type of float is meant.
 409         switch(code) {
 410         case WRAP_CODE:
 411         case FOOT_CODE:
 412         case MARGIN_CODE:
 413                 return false;
 414         default:
 415                 return InsetCollapsable::insetAllowed(code);
 416         }
 417 }
 418
 419
 420 bool InsetFloat::showInsetDialog(BufferView * bv) const
 421 {
 422         if (!InsetText::showInsetDialog(bv))
 423                 bv->showDialog("float", params2string(params()),
 424                         const_cast<InsetFloat *>(this));
 425         return true;
 426 }
 427
 428
 429 void InsetFloat::setWide(bool w, bool update_label)
 430 {
 431         params_.wide = w;
 432         if (update_label)
 433                 setNewLabel();
 434 }
 435
 436
 437 void InsetFloat::setSideways(bool s, bool update_label)
 438 {
 439         params_.sideways = s;
 440         if (update_label)
 441                 setNewLabel();
 442 }
 443
 444
 445 void InsetFloat::setSubfloat(bool s, bool update_label)
 446 {
 447         params_.subfloat = s;
 448         if (update_label)
 449                 setNewLabel();
 450 }
 451
 452
 453 void InsetFloat::setNewLabel()
 454 {
 455         docstring lab = _("float: ");
 456
 457         if (params_.subfloat)
 458                 lab = _("subfloat: ");
 459
 460         lab += floatName(params_.type);
 461
 462         if (params_.wide)
 463                 lab += '*';
 464
 465         if (params_.sideways)
 466                 lab += _(" (sideways)");
 467
 468         setLabel(lab);
 469 }
 470
 471
 472 docstring InsetFloat::getCaption(OutputParams const & runparams) const
 473 {
 474         if (paragraphs().empty())
 475                 return docstring();
 476
 477         InsetCaption const * ins = getCaptionInset();
 478         if (ins == 0)
 479                 return docstring();
 480
 481         odocstringstream ods;
 482         ins->getOptArg(ods, runparams);
 483         ods << '[';
 484         ins->getArgument(ods, runparams);
 485         ods << ']';
 486         return ods.str();
 487 }
 488
 489
 490 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 491 {
 492         params = InsetFloatParams();
 493         if (in.empty())
 494                 return;
 495
 496         istringstream data(in);
 497         Lexer lex;
 498         lex.setStream(data);
 499         lex.setContext("InsetFloat::string2params");
 500         lex >> "float" >> "Float";
 501         lex >> params.type; // We have to read the type here!
 502         params.read(lex);
 503 }
 504
 505
 506 string InsetFloat::params2string(InsetFloatParams const & params)
 507 {
 508         ostringstream data;
 509         data << "float" << ' ';
 510         params.write(data);
 511         return data.str();
 512 }
 513
 514
 515 } // namespace lyx