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