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